include/block/accounting.h

   1 /*
   2  * QEMU System Emulator block accounting
   3  *
   4  * Copyright (c) 2011 Christoph Hellwig
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #ifndef BLOCK_ACCOUNTING_H
  25 #define BLOCK_ACCOUNTING_H
  26
  27 #include <stdint.h>
  28 #include <stdbool.h>
  29
  30 #include "qemu/typedefs.h"
  31 #include "qemu/timed-average.h"
  32
  33 typedef struct BlockAcctTimedStats BlockAcctTimedStats;
  34
  35 enum BlockAcctType {
  36     BLOCK_ACCT_READ,
  37     BLOCK_ACCT_WRITE,
  38     BLOCK_ACCT_FLUSH,
  39     BLOCK_MAX_IOTYPE,
  40 };
  41
  42 struct BlockAcctTimedStats {
  43     TimedAverage latency[BLOCK_MAX_IOTYPE];
  44     unsigned interval_length; /* in seconds */
  45     QSLIST_ENTRY(BlockAcctTimedStats) entries;
  46 };
  47
  48 typedef struct BlockAcctStats {
  49     uint64_t nr_bytes[BLOCK_MAX_IOTYPE];
  50     uint64_t nr_ops[BLOCK_MAX_IOTYPE];
  51     uint64_t invalid_ops[BLOCK_MAX_IOTYPE];
  52     uint64_t failed_ops[BLOCK_MAX_IOTYPE];
  53     uint64_t total_time_ns[BLOCK_MAX_IOTYPE];
  54     uint64_t merged[BLOCK_MAX_IOTYPE];
  55     int64_t last_access_time_ns;
  56     QSLIST_HEAD(, BlockAcctTimedStats) intervals;
  57     bool account_invalid;
  58     bool account_failed;
  59 } BlockAcctStats;
  60
  61 typedef struct BlockAcctCookie {
  62     int64_t bytes;
  63     int64_t start_time_ns;
  64     enum BlockAcctType type;
  65 } BlockAcctCookie;
  66
  67 void block_acct_init(BlockAcctStats *stats, bool account_invalid,
  68                      bool account_failed);
  69 void block_acct_cleanup(BlockAcctStats *stats);
  70 void block_acct_add_interval(BlockAcctStats *stats, unsigned interval_length);
  71 BlockAcctTimedStats *block_acct_interval_next(BlockAcctStats *stats,
  72                                               BlockAcctTimedStats *s);
  73 void block_acct_start(BlockAcctStats *stats, BlockAcctCookie *cookie,
  74                       int64_t bytes, enum BlockAcctType type);
  75 void block_acct_done(BlockAcctStats *stats, BlockAcctCookie *cookie);
  76 void block_acct_failed(BlockAcctStats *stats, BlockAcctCookie *cookie);
  77 void block_acct_invalid(BlockAcctStats *stats, enum BlockAcctType type);
  78 void block_acct_merge_done(BlockAcctStats *stats, enum BlockAcctType type,
  79                            int num_requests);
  80 int64_t block_acct_idle_time_ns(BlockAcctStats *stats);
  81 double block_acct_queue_depth(BlockAcctTimedStats *stats,
  82                               enum BlockAcctType type);
  83
  84 #endif