src/tuningfork/prong.h

/*
 * Copyright 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include "tuningfork_internal.h"
#include "histogram.h"

#include <inttypes.h>
#include <vector>
#include <map>
#include <string>
#include <memory>

namespace tuningfork {

typedef ProtobufSerialization SerializedAnnotation;

// A prong holds a histogram for a given annotation and instrument key
class Prong {
public:
    InstrumentationKey instrumentation_key_;
    SerializedAnnotation annotation_;
    Histogram histogram_;
    TimePoint last_time_;
    Duration duration_;
    bool loading_;

    Prong(InstrumentationKey instrumentation_key = 0,
          const SerializedAnnotation &annotation = {},
          const TFHistogram& histogram_settings = {},
          bool loading = false);

    void Tick(TimePoint t_ns);

    void Trace(Duration dt_ns);

    void Clear();

    size_t Count() const;

    void SetInstrumentKey(InstrumentationKey key);

    bool IsLoading() const { return loading_; }
};

// Simple fixed-size cache
class ProngCache {
    std::vector<std::unique_ptr<Prong>> prongs_;
    int max_num_instrumentation_keys_;
    TimeInterval time_;
public:
    ProngCache(size_t size, int max_num_instrumentation_keys,
               const std::vector<TFHistogram>& histogram_settings,
               const std::function<SerializedAnnotation(uint64_t)>& serializeId,
               const std::function<bool(uint64_t)>& is_loading_id);

    Prong *Get(uint64_t compound_id) const;

    void Clear();

    void SetInstrumentKeys(const std::vector<InstrumentationKey>& instrument_keys);

    // Update times
    void Ping(std::chrono::system_clock::time_point t);

    TimeInterval time() const { return time_; }
    const std::vector<std::unique_ptr<Prong>>& prongs() const { return prongs_; }

};

} // namespace tuningfork {