lib/layer_by_layer_profiler/include/layer_by_layer_profiler.hpp

/*
 * Copyright (c) 2021 Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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
 *
 * 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.
 */

#ifndef LAYER_BY_LAYER_PROFILER_H
#define LAYER_BY_LAYER_PROFILER_H

#include "EventRecorder.h"
#include "tensorflow/lite/kernels/internal/compatibility.h"
#include <memory>
#include <pmu_ethosu.h>
#include <vector>

// NOTE: This profiler only works on systems with 1 NPU due to the use of
// ethosu_reserve_driver().
namespace tflite {
class LayerByLayerProfiler : public MicroProfiler {
public:
    enum Backend { PRINTF, EVENT_RECORDER };
    LayerByLayerProfiler(const std::vector<uint8_t> &event_config = {},
                         bool pmu_cycle_counter_enable            = true,
                         size_t max_events                        = 200,
                         Backend backend                          = PRINTF,
                         int32_t event_id = EventID(EventLevelError, EvtStatistics_No, EventRecordNone));
    uint32_t BeginEvent(const char *tag);
    void EndEvent(uint32_t event_handle);
    int32_t GetTotalTicks() const;
    void Log() const;

    uint64_t GetPmuCycleCounterCount() const;
    const std::vector<uint32_t> &GetPmuEventCount() const;

private:
    std::unique_ptr<const char *[]> tags_;
    std::unique_ptr<uint64_t[]> start_ticks_;
    std::unique_ptr<uint64_t[]> end_ticks_;

    std::vector<uint8_t> pmu_event_config;
    std::vector<uint32_t> pmu_event_count;
    bool pmu_cycle_counter_enable;
    uint64_t pmu_cycle_counter_count;

    size_t max_events_;
    Backend backend;
    int32_t event_id;
    size_t num_events_;

    TF_LITE_REMOVE_VIRTUAL_DELETE;
};

} // namespace tflite

#endif