o3de/Code/CryEngine/CrySystem/SystemScheduler.cpp

/*
* 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.

// Description : Implementation of the CSystemScheduler class


#include "CrySystem_precompiled.h"

#include "ProjectDefines.h"
#if defined(MAP_LOADING_SLICING)

#include "SystemScheduler.h"

#include "MiniQueue.h"
#include "ClientHandler.h"
#include "ServerHandler.h"

void CreateSystemScheduler(CSystem* pSystem)
{
    gEnv->pSystemScheduler = new CSystemScheduler(pSystem);
}

CSystemScheduler::CSystemScheduler(CSystem* pSystem)
    : m_pSystem(pSystem)
    , m_lastSliceCheckTime(0.0f)
    , m_sliceLoadingRef(0)
{
    int defaultSchedulingMode = 0;
    if (gEnv->IsDedicated())
    {
        defaultSchedulingMode = 2;
    }

    m_svSchedulingMode = REGISTER_INT("sv_scheduling", defaultSchedulingMode, 0, "Scheduling mode\n"
            " 0: Normal mode\n"
            " 1: Client\n"
            " 2: Server\n");

    m_svSchedulingBucket = REGISTER_INT("sv_schedulingBucket", 0, 0, "Scheduling bucket\n");

    m_svSchedulingAffinity = REGISTER_INT("sv_SchedulingAffinity", 0, 0, "Scheduling affinity\n");

    m_svSchedulingClientTimeout = REGISTER_INT("sv_schedulingClientTimeout", 1000, 0, "Client wait server\n");
    m_svSchedulingServerTimeout = REGISTER_INT("sv_schedulingServerTimeout", 100, 0, "Server wait server\n");

#if defined(MAP_LOADING_SLICING)
    m_svSliceLoadEnable = REGISTER_INT("sv_sliceLoadEnable", 1, 0, "Enable/disable slice loading logic\n");
    ;
    m_svSliceLoadBudget = REGISTER_INT("sv_sliceLoadBudget", 10, 0, "Slice budget\n");
    ;
    m_svSliceLoadLogging = REGISTER_INT("sv_sliceLoadLogging", 0, 0, "Enable/disable slice loading logging\n");
#endif

    m_pLastSliceName = "INACTIVE";
    m_lastSliceLine = 0;
}

CSystemScheduler::~CSystemScheduler(void)
{
}

void CSystemScheduler::SliceLoadingBegin()
{
    m_lastSliceCheckTime = gEnv->pTimer->GetAsyncTime();
    m_sliceLoadingRef++;
    m_pLastSliceName = "START";
    m_lastSliceLine = 0;
}

void CSystemScheduler::SliceLoadingEnd()
{
    m_sliceLoadingRef--;
    m_pLastSliceName = "INACTIVE";
    m_lastSliceLine = 0;
}

void CSystemScheduler::SliceAndSleep(const char* sliceName, int line)
{
#if defined(MAP_LOADING_SLICING)
    if (!gEnv->IsDedicated())
    {
        return;
    }

    if (!m_sliceLoadingRef)
    {
        return;
    }

    if (!m_svSliceLoadEnable->GetIVal())
    {
        return;
    }

    SchedulingModeUpdate();

    CTimeValue currTime = gEnv->pTimer->GetAsyncTime();

    float sliceBudget = CLAMP(m_svSliceLoadBudget->GetFVal(), 0, 1000.0f / m_pSystem->GetDedicatedMaxRate()->GetFVal());
    bool  doSleep = true;
    if ((currTime - m_pSystem->GetLastTickTime()).GetMilliSeconds() < sliceBudget)
    {
        m_lastSliceCheckTime = currTime;
        doSleep = false;
    }

    if (doSleep)
    {
        if (m_svSliceLoadLogging->GetIVal())
        {
            float diff = (currTime - m_lastSliceCheckTime).GetMilliSeconds();
            if (diff > sliceBudget)
            {
                CryLogAlways("[SliceAndSleep]: Interval between slice [%s:%i] and [%s:%i] was [%f] out of budget [%f]", m_pLastSliceName, m_lastSliceLine, sliceName, line, diff, sliceBudget);
            }
        }

        m_pSystem->SleepIfNeeded();
    }

    m_pLastSliceName = sliceName;
    m_lastSliceLine = line;
#endif
}

void CSystemScheduler::SchedulingSleepIfNeeded()
{
    if (!gEnv->IsDedicated())
    {
        return;
    }

    SchedulingModeUpdate();
    m_pSystem->SleepIfNeeded();
}

///////////////////////////////////////////////////////////////////////////////////////////////////
//
// Scheduling mode routines
//
///////////////////////////////////////////////////////////////////////////////////////////////////





///////////////////////////////////////////////////////////////////////////////////////////////////
//
// Scheduling mode update logic
//
///////////////////////////////////////////////////////////////////////////////////////////////////

void CSystemScheduler::SchedulingModeUpdate()
{
    static std::unique_ptr<ClientHandler> m_client;
    static std::unique_ptr<ServerHandler> m_server;

    if (int scheduling = m_svSchedulingMode->GetIVal())
    {
        if (scheduling == 1) //client
        {
            if (!m_client.get())
            {
                m_server.reset();
                m_client.reset(new ClientHandler(m_svSchedulingBucket->GetString(), m_svSchedulingAffinity->GetIVal(), m_svSchedulingClientTimeout->GetIVal()));
            }
            if (m_client->Sync())
            {
                return;
            }
        }
        else if (scheduling == 2) //server
        {
            if (!m_server.get())
            {
                m_client.reset();
                m_server.reset(new ServerHandler(m_svSchedulingBucket->GetString(), m_svSchedulingAffinity->GetIVal(), m_svSchedulingServerTimeout->GetIVal()));
            }
            if (m_server->Sync())
            {
                return;
            }
        }
    }
    else
    {
        m_client.reset();
        m_server.reset();
    }
}

#endif // defined(MAP_LOADING_SLICING)

extern "C" void SliceAndSleep(const char* pFunc, int line)
{
    if (GetISystemScheduler())
    {
        GetISystemScheduler()->SliceAndSleep(pFunc, line);
    }
}