// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#ifndef __EVENTPIPE_PROVIDER_H__
#define __EVENTPIPE_PROVIDER_H__

#ifdef FEATURE_PERFTRACING

#include "eventpipe.h"
#include "eventpipeconfiguration.h"
#include "slist.h"

class EventPipeEvent;

class EventPipeProvider
{
    // Declare friends.
    friend class EventPipe;
    friend class EventPipeConfiguration;

private:
    // The name of the provider.
    const SString m_providerName;

    // Bit vector containing the currently enabled keywords.
    INT64 m_keywords;

    // The current verbosity of the provider.
    EventPipeEventLevel m_providerLevel;

    // List of every event currently associated with the provider.
    // New events can be added on-the-fly.
    SList<SListElem<EventPipeEvent*>> *m_pEventList;

    // The optional provider callback.
    EventPipeCallback m_pCallbackFunction;

    // The optional provider callback data pointer.
    void *m_pCallbackData;

    // The configuration object.
    EventPipeConfiguration *m_pConfig;

    // True if the provider has been deleted, but that deletion
    // has been deferred until tracing is stopped.
    bool m_deleteDeferred;

    // Bit mask of sessions for which this provider is enabled.
    uint64_t m_sessions;

    // Private constructor because all providers are created through EventPipe::CreateProvider.
    EventPipeProvider(EventPipeConfiguration *pConfig, const SString &providerName, EventPipeCallback pCallbackFunction = NULL, void *pCallbackData = NULL);

public:

    ~EventPipeProvider();

    // Get the provider Name.
    const SString& GetProviderName() const;

    // Determine if the provider is enabled.
    bool Enabled() const
    {
        LIMITED_METHOD_CONTRACT;
        return (m_sessions != 0);
    }

    bool IsEnabled(uint64_t sessionMask) const
    {
        LIMITED_METHOD_CONTRACT;
        return ((m_sessions & sessionMask) != 0);
    }

    // Compute the enabled bit mask, the ith bit is 1 iff an event with the given (provider, keywords, eventLevel) is enabled for the ith session.
    INT64 ComputeEventEnabledMask(INT64 keywords, EventPipeEventLevel eventLevel) const;

    // Create a new event.
    EventPipeEvent* AddEvent(unsigned int eventID, INT64 keywords, unsigned int eventVersion, EventPipeEventLevel level, bool needStack, BYTE *pMetadata = NULL, unsigned int metadataLength = 0);

private:

    // Add an event to the provider.
    void AddEvent(EventPipeEvent &event);

    // Set the provider configuration (enable sets of events).
    // This is called by EventPipeConfiguration.
    EventPipeProviderCallbackData SetConfiguration(
        INT64 keywordsForAllSessions,
        EventPipeEventLevel providerLevelForAllSessions,
        uint64_t sessionMask,
        INT64 keywords,
        EventPipeEventLevel providerLevel,
        LPCWSTR pFilterData);

    // Unset the provider configuration for the specified session (disable sets of events).
    // This is called by EventPipeConfiguration.
    EventPipeProviderCallbackData UnsetConfiguration(
        INT64 keywordsForAllSessions,
        EventPipeEventLevel providerLevelForAllSessions,
        uint64_t sessionMask,
        INT64 keywords,
        EventPipeEventLevel providerLevel,
        LPCWSTR pFilterData);

    // Refresh the runtime state of all events.
    void RefreshAllEvents();

    // Prepare the data required for invoking callback
    EventPipeProviderCallbackData PrepareCallbackData(
        INT64 keywords,
        EventPipeEventLevel providerLevel,
        LPCWSTR pFilterData);

    // Invoke the provider callback.
    static void InvokeCallback(EventPipeProviderCallbackData eventPipeProviderCallbackData);

    // Specifies whether or not the provider was deleted, but that deletion
    // was deferred until after tracing is stopped.
    bool GetDeleteDeferred() const;

    // Defer deletion of the provider.
    void SetDeleteDeferred();
};

#endif // FEATURE_PERFTRACING

#endif // __EVENTPIPE_PROVIDER_H__