xref: /qemu/include/block/accounting.h (revision 1438eff3)
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 <stdint.h>
29 #include <stdbool.h>
30 
31 #include "qemu/typedefs.h"
32 #include "qemu/timed-average.h"
33 
34 typedef struct BlockAcctTimedStats BlockAcctTimedStats;
35 
36 enum BlockAcctType {
37     BLOCK_ACCT_READ,
38     BLOCK_ACCT_WRITE,
39     BLOCK_ACCT_FLUSH,
40     BLOCK_MAX_IOTYPE,
41 };
42 
43 struct BlockAcctTimedStats {
44     TimedAverage latency[BLOCK_MAX_IOTYPE];
45     unsigned interval_length; /* in seconds */
46     QSLIST_ENTRY(BlockAcctTimedStats) entries;
47 };
48 
49 typedef struct BlockAcctStats {
50     uint64_t nr_bytes[BLOCK_MAX_IOTYPE];
51     uint64_t nr_ops[BLOCK_MAX_IOTYPE];
52     uint64_t invalid_ops[BLOCK_MAX_IOTYPE];
53     uint64_t failed_ops[BLOCK_MAX_IOTYPE];
54     uint64_t total_time_ns[BLOCK_MAX_IOTYPE];
55     uint64_t merged[BLOCK_MAX_IOTYPE];
56     int64_t last_access_time_ns;
57     QSLIST_HEAD(, BlockAcctTimedStats) intervals;
58     bool account_invalid;
59     bool account_failed;
60 } BlockAcctStats;
61 
62 typedef struct BlockAcctCookie {
63     int64_t bytes;
64     int64_t start_time_ns;
65     enum BlockAcctType type;
66 } BlockAcctCookie;
67 
68 void block_acct_init(BlockAcctStats *stats, bool account_invalid,
69                      bool account_failed);
70 void block_acct_cleanup(BlockAcctStats *stats);
71 void block_acct_add_interval(BlockAcctStats *stats, unsigned interval_length);
72 BlockAcctTimedStats *block_acct_interval_next(BlockAcctStats *stats,
73                                               BlockAcctTimedStats *s);
74 void block_acct_start(BlockAcctStats *stats, BlockAcctCookie *cookie,
75                       int64_t bytes, enum BlockAcctType type);
76 void block_acct_done(BlockAcctStats *stats, BlockAcctCookie *cookie);
77 void block_acct_failed(BlockAcctStats *stats, BlockAcctCookie *cookie);
78 void block_acct_invalid(BlockAcctStats *stats, enum BlockAcctType type);
79 void block_acct_merge_done(BlockAcctStats *stats, enum BlockAcctType type,
80                            int num_requests);
81 int64_t block_acct_idle_time_ns(BlockAcctStats *stats);
82 double block_acct_queue_depth(BlockAcctTimedStats *stats,
83                               enum BlockAcctType type);
84 
85 #endif
86