xref: /openbmc/qemu/include/block/accounting.h (revision 52eb76f4)
1 /*
2  * QEMU System Emulator block accounting
3  *
4  * Copyright (c) 2011 Christoph Hellwig
5  * Copyright (c) 2015 Igalia, S.L.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  */
25 #ifndef BLOCK_ACCOUNTING_H
26 #define BLOCK_ACCOUNTING_H
27 
28 #include "qemu/timed-average.h"
29 #include "qemu/thread.h"
30 #include "qapi/qapi-types-common.h"
31 
32 typedef struct BlockAcctTimedStats BlockAcctTimedStats;
33 typedef struct BlockAcctStats BlockAcctStats;
34 
35 enum BlockAcctType {
36     BLOCK_ACCT_NONE = 0,
37     BLOCK_ACCT_READ,
38     BLOCK_ACCT_WRITE,
39     BLOCK_ACCT_FLUSH,
40     BLOCK_ACCT_ZONE_APPEND,
41     BLOCK_ACCT_UNMAP,
42     BLOCK_MAX_IOTYPE,
43 };
44 
45 struct BlockAcctTimedStats {
46     BlockAcctStats *stats;
47     TimedAverage latency[BLOCK_MAX_IOTYPE];
48     unsigned interval_length; /* in seconds */
49     QSLIST_ENTRY(BlockAcctTimedStats) entries;
50 };
51 
52 typedef struct BlockLatencyHistogram {
53     /* The following histogram is represented like this:
54      *
55      * 5|           *
56      * 4|           *
57      * 3| *         *
58      * 2| *         *    *
59      * 1| *    *    *    *
60      *  +------------------
61      *      10   50   100
62      *
63      * BlockLatencyHistogram histogram = {
64      *     .nbins = 4,
65      *     .boundaries = {10, 50, 100},
66      *     .bins = {3, 1, 5, 2},
67      * };
68      *
69      * @boundaries array define histogram intervals as follows:
70      * [0, boundaries[0]), [boundaries[0], boundaries[1]), ...
71      * [boundaries[nbins-2], +inf)
72      *
73      * So, for example above, histogram intervals are:
74      * [0, 10), [10, 50), [50, 100), [100, +inf)
75      */
76     int nbins;
77     uint64_t *boundaries; /* @nbins-1 numbers here
78                              (all boundaries, except 0 and +inf) */
79     uint64_t *bins;
80 } BlockLatencyHistogram;
81 
82 struct BlockAcctStats {
83     QemuMutex lock;
84     uint64_t nr_bytes[BLOCK_MAX_IOTYPE];
85     uint64_t nr_ops[BLOCK_MAX_IOTYPE];
86     uint64_t invalid_ops[BLOCK_MAX_IOTYPE];
87     uint64_t failed_ops[BLOCK_MAX_IOTYPE];
88     uint64_t total_time_ns[BLOCK_MAX_IOTYPE];
89     uint64_t merged[BLOCK_MAX_IOTYPE];
90     int64_t last_access_time_ns;
91     QSLIST_HEAD(, BlockAcctTimedStats) intervals;
92     bool account_invalid;
93     bool account_failed;
94     BlockLatencyHistogram latency_histogram[BLOCK_MAX_IOTYPE];
95 };
96 
97 typedef struct BlockAcctCookie {
98     int64_t bytes;
99     int64_t start_time_ns;
100     enum BlockAcctType type;
101 } BlockAcctCookie;
102 
103 void block_acct_init(BlockAcctStats *stats);
104 void block_acct_setup(BlockAcctStats *stats, enum OnOffAuto account_invalid,
105                       enum OnOffAuto account_failed);
106 void block_acct_cleanup(BlockAcctStats *stats);
107 void block_acct_add_interval(BlockAcctStats *stats, unsigned interval_length);
108 BlockAcctTimedStats *block_acct_interval_next(BlockAcctStats *stats,
109                                               BlockAcctTimedStats *s);
110 void block_acct_start(BlockAcctStats *stats, BlockAcctCookie *cookie,
111                       int64_t bytes, enum BlockAcctType type);
112 void block_acct_done(BlockAcctStats *stats, BlockAcctCookie *cookie);
113 void block_acct_failed(BlockAcctStats *stats, BlockAcctCookie *cookie);
114 void block_acct_invalid(BlockAcctStats *stats, enum BlockAcctType type);
115 void block_acct_merge_done(BlockAcctStats *stats, enum BlockAcctType type,
116                            int num_requests);
117 int64_t block_acct_idle_time_ns(BlockAcctStats *stats);
118 double block_acct_queue_depth(BlockAcctTimedStats *stats,
119                               enum BlockAcctType type);
120 int block_latency_histogram_set(BlockAcctStats *stats, enum BlockAcctType type,
121                                 uint64List *boundaries);
122 void block_latency_histograms_clear(BlockAcctStats *stats);
123 
124 #endif
125