aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/common/i_transient_resource_usage_provider.h
blob: 833b65190464b2de667e5c21ef38febf507e237f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <cstddef>

namespace proton {

/**
 * Class containing transient disk and memory usage (in bytes).
 */
class TransientResourceUsage {
private:
    size_t _disk;
    size_t _memory;

public:
    TransientResourceUsage() noexcept
        : _disk(0),
          _memory(0)
    {}
    TransientResourceUsage(size_t disk_in,
                           size_t memory_in) noexcept
        : _disk(disk_in),
          _memory(memory_in)
    {}
    size_t disk() const noexcept { return _disk; }
    size_t memory() const noexcept { return _memory; }
    void merge(const TransientResourceUsage& rhs) {
        _disk += rhs.disk();
        _memory += rhs.memory();
    }
};

/**
 * Interface class providing a snapshot of transient resource usage.
 *
 * E.g. the memory used by the memory index and extra disk needed for running disk index fusion.
 * This provides the total transient resource usage for the components this provider encapsulates.
 */
class ITransientResourceUsageProvider {
public:
    virtual ~ITransientResourceUsageProvider() = default;
    virtual TransientResourceUsage get_transient_resource_usage() const = 0;
};

}