// Copyright (c) 2018, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
//
// This file is part of Caliper.
// Written by David Boehme, boehme3@llnl.gov.
// LLNL-CODE-678900
// All rights reserved.
//
// For details, see https://github.com/scalability-llnl/Caliper.
// Please also see the LICENSE file for our additional BSD notice.
//
// 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 disclaimer below.
//  * Redistributions in binary form must reproduce the above copyright notice, this list of
//    conditions and the disclaimer (as noted below) in the documentation and/or other materials
//    provided with the distribution.
//  * Neither the name of the LLNS/LLNL 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 AND CONTRIBUTORS "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
// LAWRENCE LIVERMORE NATIONAL SECURITY, LLC, THE U.S. DEPARTMENT OF ENERGY 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.

// CuptiEventSampling.h
// Implementation of Cupti event sampling

#pragma once

#include "caliper/common/Attribute.h"

#include <cupti.h>

#include <iostream>
#include <memory>
#include <mutex>
#include <vector>

namespace cali
{

class Caliper;
class SnapshotRecord;
    
namespace Cupti
{

class EventSampling
{
    struct SamplingInfo {
        CUcontext        context;
        CUpti_EventGroup event_grp;
    };

    std::vector<SamplingInfo> m_sampling_info;
    std::mutex                m_sampling_mtx;
    
    CUpti_EventID m_event_id;

    Attribute     m_event_attr    = Attribute::invalid;

    unsigned      m_num_snapshots = 0;
    unsigned      m_num_reads     = 0;

    bool          m_enabled       = false;
    
public:

    bool is_enabled() const { return m_enabled; }

    // note: event-by-name lookup is currently broken for some reason
    bool setup(Caliper* c, const std::string& event_name);
    
    bool setup(Caliper* c, CUpti_EventID event_id);

    bool enable_sampling_for_context(CUcontext context);
    bool disable_sampling_for_context(CUcontext context);

    void stop_all();

    void snapshot(Caliper* c, const SnapshotRecord*, SnapshotRecord* snapshot);

    std::ostream&
    print_statistics(std::ostream& os);

    EventSampling();

    ~EventSampling();    
};
    
} // namespace Cupti
    
} // namespace cali
