/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#pragma once

struct SThreadConfig
{
    enum eThreadParamFlag
    {
        eThreadParamFlag_ThreadName    = BIT(0),
        eThreadParamFlag_StackSize     = BIT(1),
        eThreadParamFlag_Affinity      = BIT(2),
        eThreadParamFlag_Priority      = BIT(3),
        eThreadParamFlag_PriorityBoost = BIT(4),
    };

    typedef uint32 TThreadParamFlag;

    const char* szThreadName;
    uint32 stackSizeBytes;
    uint32 affinityFlag;
    int32 priority;
    bool bDisablePriorityBoost;

    TThreadParamFlag paramActivityFlag;
};

class IThreadConfigManager
{
public:
    virtual ~IThreadConfigManager()
    {
    }

    //! Called once during System startup.
    //! Loads the thread configuration for the executing platform from file.
    virtual bool LoadConfig(const char* pcPath) = 0;

    //! Returns true if a config has been loaded.
    virtual bool ConfigLoaded() const = 0;

    //! Gets the thread configuration for the specified thread on the active platform.
    //! If no matching config is found a default configuration is returned (which does not have the same name as the search string).
    virtual const SThreadConfig* GetThreadConfig(const char* sThreadName, ...) = 0;
    virtual const SThreadConfig* GetDefaultThreadConfig() const = 0;

    //! Dump a detailed description of the thread startup configurations for this platform to the log file.
    virtual void DumpThreadConfigurationsToLog() = 0;
};