sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget8/translations/zh_CN/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/zh_TW/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/it_IT/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/ja_JP/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/ko_KR/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/pt_BR/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget8/translations/sp_SP/admin-guide/device-mapper/statisticsmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h DM statisticsh]h DM statistics}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhR/var/lib/git/docbuild/linux/Documentation/admin-guide/device-mapper/statistics.rsthKubh paragraph)}(hDevice Mapper supports the collection of I/O statistics on user-defined regions of a DM device. If no regions are defined no statistics are collected so there isn't any performance impact. Only bio-based DM devices are currently supported.h]hDevice Mapper supports the collection of I/O statistics on user-defined regions of a DM device. If no regions are defined no statistics are collected so there isn’t any performance impact. Only bio-based DM devices are currently supported.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hEach user-defined region specifies a starting sector, length and step. Individual statistics will be collected for each step-sized area within the range specified.h]hEach user-defined region specifies a starting sector, length and step. Individual statistics will be collected for each step-sized area within the range specified.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hXThe I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending the @stats_print message to the appropriate DM device via dmsetup.h](h[The I/O statistics counters for each step-sized area of a region are in the same format as }(hhhhhNhNubhtitle_reference)}(h`/sys/block/*/stat`h]h/sys/block/*/stat}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh or }(hhhhhNhNubh)}(h`/proc/diskstats`h]h/proc/diskstats}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubhXi (see: Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending the @stats_print message to the appropriate DM device via dmsetup.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThe reported times are in milliseconds and the granularity depends on the kernel ticks. When the option precise_timestamps is used, the reported times are in nanoseconds.h]hThe reported times are in milliseconds and the granularity depends on the kernel ticks. When the option precise_timestamps is used, the reported times are in nanoseconds.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXuEach region has a corresponding unique identifier, which we call a region_id, that is assigned when the region is created. The region_id must be supplied when querying statistics about the region, deleting the region, etc. Unique region_ids enable multiple userspace programs to request and process statistics for the same DM device without stepping on each other's data.h]hXwEach region has a corresponding unique identifier, which we call a region_id, that is assigned when the region is created. The region_id must be supplied when querying statistics about the region, deleting the region, etc. Unique region_ids enable multiple userspace programs to request and process statistics for the same DM device without stepping on each other’s data.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThe creation of DM statistics will allocate memory via kmalloc or fallback to using vmalloc space. At most, 1/4 of the overall system memory may be allocated by DM statistics. The admin can see how much memory is used by reading:h]hThe creation of DM statistics will allocate memory via kmalloc or fallback to using vmalloc space. At most, 1/4 of the overall system memory may be allocated by DM statistics. The admin can see how much memory is used by reading:}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK!hhhhubh block_quote)}(h [ ...] [ []] Create a new region and return the region_id. "-" whole device "+" a range of 512-byte sectors starting with . "" the range is subdivided into areas each containing sectors. "/" the range is subdivided into the specified number of areas. The number of optional arguments The following optional arguments are supported: precise_timestamps use precise timer with nanosecond resolution instead of the "jiffies" variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps. histogram:n1,n2,n3,n4,... collect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use "histogram:10,20,30", the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete. An optional parameter. A name that uniquely identifies the userspace owner of the range. This groups ranges together so that userspace programs can identify the ranges they created and ignore those created by others. The kernel returns this string back in the output of @stats_list message, but it doesn't use it for anything else. If we omit the number of optional arguments, program id must not be a number, otherwise it would be interpreted as the number of optional arguments. An optional parameter. A word that provides auxiliary data that is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. @stats_delete Delete the region with the specified id. region_id returned from @stats_create @stats_clear Clear all the counters except the in-flight i/o counters. region_id returned from @stats_create @stats_list [] List all regions registered with @stats_create. An optional parameter. If this parameter is specified, only matching regions are returned. If it is not specified, all regions are returned. Output format: : + precise_timestamps histogram:n1,n2,n3,... The strings "precise_timestamps" and "histogram" are printed only if they were specified when creating the region. @stats_print [ ] Print counters for each step-sized area of a region. region_id returned from @stats_create The index of the starting line in the output. If omitted, all lines are returned. The number of lines to include in the output. If omitted, all lines are returned. Output format for each step-sized area of a region: + counters The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged 3. the number of sectors read 4. the number of milliseconds spent reading 5. the number of writes completed 6. the number of writes merged 7. the number of sectors written 8. the number of milliseconds spent writing 9. the number of I/Os currently in progress 10. the number of milliseconds spent doing I/Os 11. the weighted number of milliseconds spent doing I/Os Additional counters: 12. the total time spent reading in milliseconds 13. the total time spent writing in milliseconds @stats_print_clear [ ] Atomically print and then clear all the counters except the in-flight i/o counters. Useful when the client consuming the statistics does not want to lose any statistics (those updated between printing and clearing). region_id returned from @stats_create The index of the starting line in the output. If omitted, all lines are printed and then cleared. The number of lines to process. If omitted, all lines are printed and then cleared. @stats_set_aux Store auxiliary data aux_data for the specified region. region_id returned from @stats_create The string that identifies data which is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. h]hdefinition_list)}(hhh](hdefinition_list_item)}(hX @stats_create [ ...] [ []] Create a new region and return the region_id. "-" whole device "+" a range of 512-byte sectors starting with . "" the range is subdivided into areas each containing sectors. "/" the range is subdivided into the specified number of areas. The number of optional arguments The following optional arguments are supported: precise_timestamps use precise timer with nanosecond resolution instead of the "jiffies" variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps. histogram:n1,n2,n3,n4,... collect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use "histogram:10,20,30", the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete. An optional parameter. A name that uniquely identifies the userspace owner of the range. This groups ranges together so that userspace programs can identify the ranges they created and ignore those created by others. The kernel returns this string back in the output of @stats_list message, but it doesn't use it for anything else. If we omit the number of optional arguments, program id must not be a number, otherwise it would be interpreted as the number of optional arguments. An optional parameter. A word that provides auxiliary data that is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. h](hterm)}(hq@stats_create [ ...] [ []]h]hq@stats_create [ ...] [ []]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKfhj}ubh definition)}(hhh](h)}(h-Create a new region and return the region_id.h]h-Create a new region and return the region_id.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK,hjubjw)}(hhh](j|)}(h "-" whole device "+" a range of 512-byte sectors starting with . h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK3hjubj)}(hhh]jw)}(hhh](j|)}(h"-" whole deviceh](j)}(h"-"h]h“-”}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK/hjubj)}(hhh]h)}(h whole deviceh]h whole device}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK0hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhK/hjubj|)}(h]"+" a range of 512-byte sectors starting with . h](j)}(h"+"h]h“+”}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK3hjubj)}(hhh]h)}(hBa range of 512-byte sectors starting with .h]hBa range of 512-byte sectors starting with .}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhK3hjubeh}(h]h ]h"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhK3hjubj|)}(h "" the range is subdivided into areas each containing sectors. "/" the range is subdivided into the specified number of areas. h](j)}(hh]h}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK;hj/ubj)}(hhh]jw)}(hhh](j|)}(hU"" the range is subdivided into areas each containing sectors.h](j)}(h ""h]h“”}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK7hjGubj)}(hhh]h)}(hGthe range is subdivided into areas each containing sectors.h]hGthe range is subdivided into areas each containing sectors.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjYubah}(h]h ]h"]h$]h&]uh1jhjGubeh}(h]h ]h"]h$]h&]uh1j{hhhK7hjDubj|)}(hQ"/" the range is subdivided into the specified number of areas. h](j)}(h"/"h]h“/”}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK;hjvubj)}(hhh]h)}(h;the range is subdivided into the specified number of areas.h]h;the range is subdivided into the specified number of areas.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK:hjubah}(h]h ]h"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]uh1j{hhhK;hjDubeh}(h]h ]h"]h$]h&]uh1jvhjAubah}(h]h ]h"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]uh1j{hhhK;hjubj|)}(h@ The number of optional arguments h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK>hjubj)}(hhh]h)}(h The number of optional argumentsh]h The number of optional arguments}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK>hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhK>hjubj|)}(hXh The following optional arguments are supported: precise_timestamps use precise timer with nanosecond resolution instead of the "jiffies" variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps. histogram:n1,n2,n3,n4,... collect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use "histogram:10,20,30", the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete. h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKUhjubj)}(hhh](h)}(h/The following optional arguments are supported:h]h/The following optional arguments are supported:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjubjw)}(hhh](j|)}(hXprecise_timestamps use precise timer with nanosecond resolution instead of the "jiffies" variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps.h](j)}(hprecise_timestampsh]hprecise_timestamps}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKGhj ubj)}(hhh]h)}(hXuse precise timer with nanosecond resolution instead of the "jiffies" variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps.h]hXuse precise timer with nanosecond resolution instead of the “jiffies” variable. When this argument is used, the resulting times are in nanoseconds instead of milliseconds. Precise timestamps are a little bit slower to obtain than jiffies-based timestamps.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKDhjubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1j{hhhKGhj ubj|)}(hXhistogram:n1,n2,n3,n4,... collect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use "histogram:10,20,30", the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete. h](j)}(hhistogram:n1,n2,n3,n4,...h]hhistogram:n1,n2,n3,n4,...}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKUhj;ubj)}(hhh]h)}(hXcollect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use "histogram:10,20,30", the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete.h]hXcollect histogram of latencies. The numbers n1, n2, etc are times that represent the boundaries of the histogram. If precise_timestamps is not used, the times are in milliseconds, otherwise they are in nanoseconds. For each range, the kernel will report the number of requests that completed within this range. For example, if we use “histogram:10,20,30”, the kernel will report four numbers a:b:c:d. a is the number of requests that took 0-10 ms to complete, b is the number of requests that took 10-20 ms to complete, c is the number of requests that took 20-30 ms to complete and d is the number of requests that took more than 30 ms to complete.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKJhjMubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1j{hhhKUhj ubeh}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKUhjubj|)}(hX An optional parameter. A name that uniquely identifies the userspace owner of the range. This groups ranges together so that userspace programs can identify the ranges they created and ignore those created by others. The kernel returns this string back in the output of @stats_list message, but it doesn't use it for anything else. If we omit the number of optional arguments, program id must not be a number, otherwise it would be interpreted as the number of optional arguments. h](j)}(h h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK`hj|ubj)}(hhh]h)}(hXAn optional parameter. A name that uniquely identifies the userspace owner of the range. This groups ranges together so that userspace programs can identify the ranges they created and ignore those created by others. The kernel returns this string back in the output of @stats_list message, but it doesn't use it for anything else. If we omit the number of optional arguments, program id must not be a number, otherwise it would be interpreted as the number of optional arguments.h]hXAn optional parameter. A name that uniquely identifies the userspace owner of the range. This groups ranges together so that userspace programs can identify the ranges they created and ignore those created by others. The kernel returns this string back in the output of @stats_list message, but it doesn’t use it for anything else. If we omit the number of optional arguments, program id must not be a number, otherwise it would be interpreted as the number of optional arguments.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjubah}(h]h ]h"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]uh1j{hhhK`hjubj|)}(h An optional parameter. A word that provides auxiliary data that is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. h](j)}(h h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKfhjubj)}(hhh]h)}(hAn optional parameter. A word that provides auxiliary data that is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything.h]hAn optional parameter. A word that provides auxiliary data that is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn’t use this value for anything.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKchjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKfhjubeh}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1jhj}ubeh}(h]h ]h"]h$]h&]uh1j{hhhKfhjxubj|)}(hx@stats_delete Delete the region with the specified id. region_id returned from @stats_create h](j)}(h@stats_delete h]h@stats_delete }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKlhjubj)}(hhh](h)}(h(Delete the region with the specified id.h]h(Delete the region with the specified id.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKihjubjw)}(hhh]j|)}(h2 region_id returned from @stats_create h](j)}(h h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKlhjubj)}(hhh]h)}(h%region_id returned from @stats_createh]h%region_id returned from @stats_create}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKlhj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKlhjubah}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKlhjxubj|)}(h@stats_clear Clear all the counters except the in-flight i/o counters. region_id returned from @stats_create h](j)}(h@stats_clear h]h@stats_clear }(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKrhjSubj)}(hhh](h)}(h9Clear all the counters except the in-flight i/o counters.h]h9Clear all the counters except the in-flight i/o counters.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKohjeubjw)}(hhh]j|)}(h2 region_id returned from @stats_create h](j)}(h h]h }(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKrhjyubj)}(hhh]h)}(h%region_id returned from @stats_createh]h%region_id returned from @stats_create}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKrhjubah}(h]h ]h"]h$]h&]uh1jhjyubeh}(h]h ]h"]h$]h&]uh1j{hhhKrhjvubah}(h]h ]h"]h$]h&]uh1jvhjeubeh}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1j{hhhKrhjxubj|)}(hX@stats_list [] List all regions registered with @stats_create. An optional parameter. If this parameter is specified, only matching regions are returned. If it is not specified, all regions are returned. Output format: : + precise_timestamps histogram:n1,n2,n3,... The strings "precise_timestamps" and "histogram" are printed only if they were specified when creating the region. h](j)}(h@stats_list []h]h@stats_list []}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(h/List all regions registered with @stats_create.h]h/List all regions registered with @stats_create.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhjubjw)}(hhh](j|)}(h An optional parameter. If this parameter is specified, only matching regions are returned. If it is not specified, all regions are returned. h](j)}(h h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK{hjubj)}(hhh]h)}(hAn optional parameter. If this parameter is specified, only matching regions are returned. If it is not specified, all regions are returned.h]hAn optional parameter. If this parameter is specified, only matching regions are returned. If it is not specified, all regions are returned.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKxhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhK{hjubj|)}(hOutput format: : + precise_timestamps histogram:n1,n2,n3,... h](j)}(hOutput format:h]hOutput format:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]jw)}(hhh]j|)}(hn: + precise_timestamps histogram:n1,n2,n3,... h](j)}(hC: + h]hC: + }(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj'ubj)}(hhh]h)}(h)precise_timestamps histogram:n1,n2,n3,...h]h)precise_timestamps histogram:n1,n2,n3,...}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj9ubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1j{hhhKhj$ubah}(h]h ]h"]h$]h&]uh1jvhj!ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjubeh}(h]h ]h"]h$]h&]uh1jvhjubh)}(hrThe strings "precise_timestamps" and "histogram" are printed only if they were specified when creating the region.h]hzThe strings “precise_timestamps” and “histogram” are printed only if they were specified when creating the region.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjxubj|)}(hX@stats_print [ ] Print counters for each step-sized area of a region. region_id returned from @stats_create The index of the starting line in the output. If omitted, all lines are returned. The number of lines to include in the output. If omitted, all lines are returned. Output format for each step-sized area of a region: + counters The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged 3. the number of sectors read 4. the number of milliseconds spent reading 5. the number of writes completed 6. the number of writes merged 7. the number of sectors written 8. the number of milliseconds spent writing 9. the number of I/Os currently in progress 10. the number of milliseconds spent doing I/Os 11. the weighted number of milliseconds spent doing I/Os Additional counters: 12. the total time spent reading in milliseconds 13. the total time spent writing in milliseconds h](j)}(h<@stats_print [ ]h]h<@stats_print [ ]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(h4Print counters for each step-sized area of a region.h]h4Print counters for each step-sized area of a region.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjw)}(hhh](j|)}(h2 region_id returned from @stats_create h](j)}(h h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h%region_id returned from @stats_createh]h%region_id returned from @stats_create}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjubj|)}(hb The index of the starting line in the output. If omitted, all lines are returned. h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hQThe index of the starting line in the output. If omitted, all lines are returned.h]hQThe index of the starting line in the output. If omitted, all lines are returned.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjubj|)}(hd The number of lines to include in the output. If omitted, all lines are returned. h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj ubj)}(hhh]h)}(hQThe number of lines to include in the output. If omitted, all lines are returned.h]hQThe number of lines to include in the output. If omitted, all lines are returned.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjubeh}(h]h ]h"]h$]h&]uh1jvhjubh)}(h3Output format for each step-sized area of a region:h]h3Output format for each step-sized area of a region:}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjH)}(hX+ counters The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged 3. the number of sectors read 4. the number of milliseconds spent reading 5. the number of writes completed 6. the number of writes merged 7. the number of sectors written 8. the number of milliseconds spent writing 9. the number of I/Os currently in progress 10. the number of milliseconds spent doing I/Os 11. the weighted number of milliseconds spent doing I/Os Additional counters: 12. the total time spent reading in milliseconds 13. the total time spent writing in milliseconds h](jw)}(hhh]j|)}(h!+ counters h](j)}(h+h]h+}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjVubj)}(hhh]h)}(hcountersh]hcounters}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhubah}(h]h ]h"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjSubah}(h]h ]h"]h$]h&]uh1jvhjOubh)}(hVThe first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`.h](h/The first 11 counters have the same meaning as }(hjhhhNhNubh)}(h&`/sys/block/*/stat or /proc/diskstats`h]h$/sys/block/*/stat or /proc/diskstats}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjOubh)}(hBPlease refer to Documentation/admin-guide/iostats.rst for details.h]hBPlease refer to Documentation/admin-guide/iostats.rst for details.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjOubhenumerated_list)}(hhh](h list_item)}(hthe number of reads completedh]h)}(hjh]hthe number of reads completed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hthe number of reads mergedh]h)}(hjh]hthe number of reads merged}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hthe number of sectors readh]h)}(hjh]hthe number of sectors read}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h(the number of milliseconds spent readingh]h)}(hjh]h(the number of milliseconds spent reading}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hthe number of writes completedh]h)}(hjh]hthe number of writes completed}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hthe number of writes mergedh]h)}(hj5h]hthe number of writes merged}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj3ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hthe number of sectors writtenh]h)}(hjLh]hthe number of sectors written}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjJubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h(the number of milliseconds spent writingh]h)}(hjch]h(the number of milliseconds spent writing}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjaubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h(the number of I/Os currently in progressh]h)}(hjzh]h(the number of I/Os currently in progress}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjxubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h+the number of milliseconds spent doing I/Osh]h)}(hjh]h+the number of milliseconds spent doing I/Os}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h5the weighted number of milliseconds spent doing I/Os h]h)}(h4the weighted number of milliseconds spent doing I/Osh]h4the weighted number of milliseconds spent doing I/Os}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjOubh)}(hAdditional counters:h]hAdditional counters:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjOubj)}(hhh](j)}(h,the total time spent reading in millisecondsh]h)}(hjh]h,the total time spent reading in milliseconds}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h-the total time spent writing in milliseconds h]h)}(h,the total time spent writing in millisecondsh]h,the total time spent writing in milliseconds}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jjjhjjstartK uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jGhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjxubj|)}(hX3@stats_print_clear [ ] Atomically print and then clear all the counters except the in-flight i/o counters. Useful when the client consuming the statistics does not want to lose any statistics (those updated between printing and clearing). region_id returned from @stats_create The index of the starting line in the output. If omitted, all lines are printed and then cleared. The number of lines to process. If omitted, all lines are printed and then cleared. h](j)}(hB@stats_print_clear [ ]h]hB@stats_print_clear [ ]}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj"ubj)}(hhh](h)}(hAtomically print and then clear all the counters except the in-flight i/o counters. Useful when the client consuming the statistics does not want to lose any statistics (those updated between printing and clearing).h]hAtomically print and then clear all the counters except the in-flight i/o counters. Useful when the client consuming the statistics does not want to lose any statistics (those updated between printing and clearing).}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubjw)}(hhh](j|)}(h2 region_id returned from @stats_create h](j)}(h h]h }(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjHubj)}(hhh]h)}(h%region_id returned from @stats_createh]h%region_id returned from @stats_create}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjZubah}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjEubj|)}(hr The index of the starting line in the output. If omitted, all lines are printed and then cleared. h](j)}(hh]h}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjwubj)}(hhh]h)}(haThe index of the starting line in the output. If omitted, all lines are printed and then cleared.h]haThe index of the starting line in the output. If omitted, all lines are printed and then cleared.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjwubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjEubj|)}(hf The number of lines to process. If omitted, all lines are printed and then cleared. h](j)}(hh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hSThe number of lines to process. If omitted, all lines are printed and then cleared.h]hSThe number of lines to process. If omitted, all lines are printed and then cleared.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjEubeh}(h]h ]h"]h$]h&]uh1jvhj4ubeh}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjxubj|)}(hX|@stats_set_aux Store auxiliary data aux_data for the specified region. region_id returned from @stats_create The string that identifies data which is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. h](j)}(h%@stats_set_aux h]h%@stats_set_aux }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(h7Store auxiliary data aux_data for the specified region.h]h7Store auxiliary data aux_data for the specified region.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjw)}(hhh](j|)}(h2 region_id returned from @stats_create h](j)}(h h]h }(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj ubj)}(hhh]h)}(h%region_id returned from @stats_createh]h%region_id returned from @stats_create}(hj" hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1j{hhhKhj ubj|)}(h The string that identifies data which is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything. h](j)}(h h]h }(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj< ubj)}(hhh]h)}(hThe string that identifies data which is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn't use this value for anything.h]hThe string that identifies data which is useful to the client program that created the range. The kernel returns this string back in the output of @stats_list message, but it doesn’t use this value for anything.}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjN ubah}(h]h ]h"]h$]h&]uh1jhj< ubeh}(h]h ]h"]h$]h&]uh1j{hhhKhj ubeh}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1j{hhhKhjxubeh}(h]h ]h"]h$]h&]uh1jvhjrubah}(h]h ]h"]h$]h&]uh1jGhhhK+hjahhubeh}(h]messagesah ]h"]messagesah$]h&]uh1hhhhhhhhK)ubh)}(hhh](h)}(hExamplesh]hExamples}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hWSubdivide the DM device 'vol' into 100 pieces and start collecting statistics on them::h]hZSubdivide the DM device ‘vol’ into 100 pieces and start collecting statistics on them:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubh literal_block)}(h*dmsetup message vol 0 @stats_create - /100h]h*dmsetup message vol 0 @stats_create - /100}hj sbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1j hhhKhj hhubh)}(hSet the auxiliary data string to "foo bar baz" (the escape for each space must also be escaped, otherwise the shell will consume them)::h]hSet the auxiliary data string to “foo bar baz” (the escape for each space must also be escaped, otherwise the shell will consume them):}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h6dmsetup message vol 0 @stats_set_aux 0 foo\\ bar\\ bazh]h6dmsetup message vol 0 @stats_set_aux 0 foo\\ bar\\ baz}hj sbah}(h]h ]h"]h$]h&]j j uh1j hhhKhj hhubh)}(hList the statistics::h]hList the statistics:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h!dmsetup message vol 0 @stats_listh]h!dmsetup message vol 0 @stats_list}hj sbah}(h]h ]h"]h$]h&]j j uh1j hhhKhj hhubh)}(hPrint the statistics::h]hPrint the statistics:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h$dmsetup message vol 0 @stats_print 0h]h$dmsetup message vol 0 @stats_print 0}hj sbah}(h]h ]h"]h$]h&]j j uh1j hhhKhj hhubh)}(hDelete the statistics::h]hDelete the statistics:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h%dmsetup message vol 0 @stats_delete 0h]h%dmsetup message vol 0 @stats_delete 0}hj$ sbah}(h]h ]h"]h$]h&]j j uh1j hhhKhj hhubeh}(h]examplesah ]h"]examplesah$]h&]uh1hhhhhhhhKubeh}(h] dm-statisticsah ]h"] dm statisticsah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerje error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehʌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j? j< j j j7 j4 u nametypes}(j? j j7 uh}(j< hj jaj4 j u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]hsystem_message)}(hhh]h)}(h