NvElementProfiler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *  * Neither the name of NVIDIA CORPORATION nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __NV_ELEMENT_PROFILER_H__
#define __NV_ELEMENT_PROFILER_H__
 
#include <iostream>
#include <pthread.h>
#include <map>
#include <stdint.h>
#include <sys/time.h>
 
class NvElementProfiler {
public:
    typedef int ProfilerField;
    static const ProfilerField PROFILER_FIELD_NONE = 0;
    static const ProfilerField PROFILER_FIELD_TOTAL_UNITS = 1;
    static const ProfilerField PROFILER_FIELD_LATE_UNITS = 2;
    static const ProfilerField PROFILER_FIELD_LATENCIES = 4;
    static const ProfilerField PROFILER_FIELD_FPS = 8;
    static const ProfilerField PROFILER_FIELD_ALL = (PROFILER_FIELD_FPS << 1) - 1;
    typedef struct {
        ProfilerField valid_fields;
 
        uint64_t average_latency_usec;
        uint64_t min_latency_usec;
        uint64_t max_latency_usec;
 
        uint64_t total_processed_units;
        uint64_t num_late_units;
 
        float average_fps;
 
        struct timeval profiling_time;
    } NvElementProfilerData;
 
    void getProfilerData(NvElementProfilerData &data);
 
    void printProfilerData(std::ostream &out_stream = std::cout);
 
    uint64_t startProcessing();
 
    void finishProcessing(uint64_t id, bool is_late);
 
    void enableProfiling(bool reset_data);
 
    void disableProfiling();
private:
    void reset();
 
    pthread_mutex_t profiler_lock; 
    bool enabled; 
    const ProfilerField valid_fields; 
    struct NvElementProfilerDataInternal : NvElementProfilerData {
        struct timeval start_time;
 
        struct timeval stop_time;
 
        struct timeval accumulated_time;
 
        uint64_t total_latency;
    } data_int;
 
    std::map<uint64_t, struct timeval> unit_start_time_queue;
 
    uint64_t unit_id_counter; 
    NvElementProfiler(ProfilerField fields);
 
    NvElementProfiler(const NvElementProfiler& that);
    void operator=(NvElementProfiler const&);
 
    ~NvElementProfiler();
 
    friend class NvElement;
};
 
#endif