vm.cpp

Go to the documentation of this file.

/*
        Skyscraper 2.0 - Nanokernel
        Copyright (C)2003-2024 Ryan Thoryk
        https://www.skyscrapersim.net
        https://sourceforge.net/projects/skyscraper/
        Contact - ryan@skyscrapersim.net
 
        This program is free software; you can redistribute it and/or
        modify it under the terms of the GNU General Public License
        as published by the Free Software Foundation; either version 2
        of the License, or (at your option) any later version.
 
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.
 
        You should have received a copy of the GNU General Public License
        along with this program; if not, write to the Free Software
        Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#if OGRE_PLATFORM == OGRE_PLATFORM_APPLE
#include <sys/sysctl.h>
#endif
#if OGRE_PLATFORM == OGRE_PLATFORM_WIN32
#include <windows.h>
#endif
#if OGRE_PLATFORM == OGRE_PLATFORM_LINUX
#include <sys/utsname.h>
#endif
#include <iostream>
#include "globals.h"
#include "sbs.h"
#include "vm.h"
#include "camera.h"
#include "scenenode.h"
#include "soundsystem.h"
#include "enginecontext.h"
#include "hal.h"
#include "sky.h"
#include "gui.h"
#include "profiler.h"
#include "vmconsole.h"
 
using namespace SBS;
 
namespace Skyscraper {
 
extern VMConsoleInput inputmgr; //console input manager
 
//Virtual Manager system
 
VM::VM()
{
        //initialize values
        parent = 0;
        active_engine = 0;
        Shutdown = false;
        ConcurrentLoads = false;
        RenderOnStartup = false;
        CheckScript = false;
        Pause = false;
        CutLandscape = true;
        CutBuildings = true;
        CutExternal = false;
        CutFloors = false;
        first_run = true;
        Verbose = false;
        showconsole = false;
        vmconsole = 0;
        loadstart = false;
        unloaded = false;
 
        macos_major = 0;
        macos_minor = 0;
 
        //create HAL instance
        hal = new HAL(this);
 
        //create sky system instance
        skysystem = new SkySystem(this);
 
        //create GUI instance
#ifdef USING_WX
        gui = new GUI(this);
#else
        gui = 0;
#endif
 
        Report("Started");
}
 
VM::~VM()
{
        Report("Shutting down...");
 
        //delete sky system instance
        if (skysystem)
                delete skysystem;
        skysystem = 0;
 
        //delete HAL instance
        if (hal)
                delete hal;
        hal = 0;
 
        //delete GUI instance
#ifdef USING_WX
        if (gui)
                delete gui;
        gui = 0;
#endif
 
        //delete VM console
        if (vmconsole)
                delete vmconsole;
        vmconsole = 0;
}
 
void VM::SetParent(wxWindow *parent)
{
        //sets the parent WX window to be used by the system, mainly for the GUI
 
        this->parent = parent;
}
 
HAL* VM::GetHAL()
{
        //returns HAL instance
 
        return hal;
}
 
SkySystem* VM::GetSkySystem()
{
        //returns sky system instance
 
        return skysystem;
}
 
GUI* VM::GetGUI()
{
        return gui;
}
 
EngineContext* VM::CreateEngine(EngineContext *parent, const Vector3 &position, Real rotation, const Vector3 &area_min, const Vector3 &area_max)
{
        EngineContext* engine = new EngineContext(parent, this, hal->GetSceneManager(), hal->GetSoundSystem(), position, rotation, area_min, area_max);
        return engine;
}
 
bool VM::DeleteEngine(EngineContext *engine)
{
        //delete a specified sim engine instance
 
        if (!engine)
                return false;
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i] == engine)
                {
                        engines[i] = 0;
                        delete engine;
                        Report("Engine instance " + ToString(i) + " deleted");
 
                        int count = GetEngineCount();
 
                        if (active_engine == engine)
                        {
                                //if deleting the active engine, switch to the first valid engine
                                active_engine = 0;
                                if (count > 0)
                                {
                                        int number = GetFirstValidEngine()->GetNumber();
                                        SetActiveEngine(number, false, true);
                                }
                        }
                        else if (active_engine)
                        {
                                //if deleting another engine (not the active one), refresh the camera
                                active_engine->RefreshCamera();
                        }
 
                        //exit to main menu if all engines have been deleted
                        if (count == 0)
                                Shutdown = true;
 
                        return true;
                }
        }
        return false;
}
 
void VM::DeleteEngines()
{
        //delete all sim emgine instances
 
        Report("Deleting all engines...");
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                        delete engines[i];
        }
        engines.clear();
        active_engine = 0;
        unloaded = true;
}
 
EngineContext* VM::FindActiveEngine()
{
        //find engine instance with an active camera
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        if (engines[i]->IsCameraActive() == true)
                                return engines[i];
                }
        }
        return active_engine;
}
 
void VM::SetActiveEngine(int number, bool switch_engines, bool force)
{
        //set an engine instance to be active
 
        EngineContext *engine = GetEngine(number);
 
        if (!engine)
                return;
 
        if (active_engine == engine)
                return;
 
        //don't switch if the camera's already active in the specified engine
        if (engine->IsCameraActive() == true)
                return;
 
        //don't switch to engine if it's loading
        if (engine->IsLoading() == true && force == false)
                return;
 
        CameraState state;
        bool state_set = false;
 
        if (active_engine)
        {
                //get previous engine's camera state
                if (switch_engines == true)
                {
                        state = active_engine->GetCameraState();
                        state_set = true;
                }
 
                //detach camera from current engine
                active_engine->DetachCamera(switch_engines);
        }
 
        Report("Setting engine " + ToString(number) + " as active");
 
        //switch context to new engine instance
        active_engine = engine;
        active_engine->AttachCamera(hal->mCameras, !switch_engines);
 
        //apply camera state to new engine
        if (switch_engines == true && state_set == true)
                active_engine->SetCameraState(state, false);
 
        //update mouse cursor for freelook mode
        //frontend->GetWindow()->EnableFreelook(active_engine->GetSystem()->camera->Freelook); //FIXME
}
 
bool VM::RunEngines(std::vector<EngineContext*> &newengines)
{
        //run sim engine instances, and returns the new engine(s) created (if applicable)
        //to be started by the frontend
 
        SBS_PROFILE_MAIN("Engines");
 
        bool result = true;
        bool isloading = IsEngineLoading();
 
        if (ConcurrentLoads == true && isloading == true)
                hal->RefreshViewport();
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (!engines[i])
                        continue;
 
                //process engine run loops, and also prevent other instances from running if
                //one or more engines are loading
                if (ConcurrentLoads == true || isloading == false || engines[i]->IsLoading() == true || RenderOnStartup == true)
                {
                        bool run = true;
                        if (i > 0 && ConcurrentLoads == false)
                        {
                                //if concurrent loads is off, skip running if previous engine is not finished loading
                                if (engines[i - 1])
                                {
                                        if (engines[i - 1]->IsLoading() == true && engines[i - 1]->IsLoadingFinished() == false)
                                                run = false;
                                }
                        }
 
                        if (engines[i]->IsLoadingFinished() == false && run == true)
                        {
                                //process engine runloop
                                engines[i]->GatherReset();
                                if (engines[i]->Run() == false)
                                        result = false;
                                engines[i]->Gather();
                        }
                }
 
                //start engine if loading is finished
                if (RenderOnStartup == false)
                {
                        if (engines[i]->IsLoadingFinished() == true)
                        {
                                if (active_engine)
                                {
                                        //exit if active engine is still loading
                                        if (active_engine->IsLoading() == true && active_engine->IsLoadingFinished() == false)
                                                continue;
 
                                        //exit if active engine is finished, but other buildings are still loading
                                        if (active_engine->IsLoadingFinished() == true && isloading == true)
                                                continue;
                                }
                                engines[i]->NewEngine = false;
                                newengines.emplace_back(engines[i]);
                        }
                }
                else
                {
                        //when RenderOnStartup is true, only add new engines to the list
                        if (engines[i]->NewEngine == true)
                        {
                                newengines.emplace_back(engines[i]);
                                engines[i]->NewEngine = false;
                        }
                }
        }
        return result;
}
 
bool VM::IsEngineLoading()
{
        //return true if an engine is loading
 
        bool result = false;
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        if (engines[i]->IsLoading() == true && engines[i]->IsLoadingFinished() == false)
                                result = true;
                }
        }
        return result;
}
 
void VM::HandleEngineShutdown()
{
        //shutdown an engine if requested
 
        bool deleted = false;
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        //delete engine if it's shutdown state is true
                        if (engines[i]->GetShutdownState() == true)
                        {
                                Report("Shutdown requested for engine instance " + ToString(i));
 
                                if (DeleteEngine(engines[i]) == true)
                                {
                                        hal->RefreshViewport();
                                        i--;
                                        deleted = true;
                                }
                        }
                }
        }
 
        //clean up empty engine slots at the end of the list
        if (deleted == true)
        {
                for (size_t i = engines.size() - 1; i < engines.size(); --i)
                {
                        if (!engines[i])
                                engines.erase(engines.begin() + i);
                        else
                                break;
                }
        }
}
 
void VM::HandleReload()
{
        //reload building if requested
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        if (engines[i]->Reload == true)
                        {
                                //unload sky system if primary engine
                                if (i == 0)
                                        skysystem->UnloadSky();
 
                                Pause = false;
                                Report("Reloading engine instance " + ToString(i));
 
                                engines[i]->DoReload(); //handle engine reload
 
                                //create sky system if primary engine
                                if (i == 0)
                                        skysystem->CreateSky(engines[i]);
                        }
                }
        }
}
 
EngineContext* VM::GetEngine(int number)
{
        //get an engine by instance number
 
        if (number < 0 || number >= (int)engines.size())
                return 0;
 
        return engines[number];
}
 
int VM::GetEngineCount(bool loading_only)
{
        //get number of valid engines
 
        int count = 0;
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        if (loading_only == true)
                        {
                                if (engines[i]->IsLoading() == true)
                                        count++;
                        }
                        else
                                count++;
                }
        }
        return count;
}
 
void VM::SwitchEngines()
{
        //if user is no longer inside the active engine, find a new engine to attach to
 
        if (!active_engine)
                return;
 
        //exit if user is inside an engine
        if (active_engine->IsInside() == true)
                return;
 
        EngineContext *parent = active_engine->GetParent();
 
        //if active engine has a parent, switch to the parent if possible
        if (parent)
        {
                if (parent->IsInside() == true && parent->IsCameraActive() == false)
                {
                        SetActiveEngine(parent->GetNumber(), true);
                        return;
                }
        }
 
        //otherwise search for a valid engine to attach to
        Report("Searching for engine to attach to...");
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i] != active_engine && engines[i])
                {
                        if (engines[i]->IsInside() == true && engines[i]->IsCameraActive() == false)
                        {
                                SetActiveEngine((int)i, true);
                                return;
                        }
                }
        }
 
        //if user has stepped outside of all sim engines, revert the movement
        //to place them back into the active engine
        active_engine->RevertMovement();
}
 
bool VM::IsValidEngine(EngineContext *engine)
{
        //returns true if the specified engine is valid (currently running)
 
        if (!engine)
                return false;
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i] == engine)
                        return true;
        }
        return false;
}
 
bool VM::IsValidSystem(::SBS::SBS *sbs)
{
        //returns true if the specified SBS instance is valid (being used by an engine context)
 
        if (!sbs)
                return false;
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                {
                        if (engines[i]->GetSystem() == sbs)
                                return true;
                }
        }
        return false;
}
 
int VM::GetFreeInstanceNumber()
{
        //get an available engine instance number
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (!engines[i])
                        return (int)i;
        }
        return (int)engines.size();
}
 
int VM::RegisterEngine(EngineContext *engine)
{
        //register an engine, returning the assigned instance number
 
        int number = GetFreeInstanceNumber();
 
        if (number < (int)engines.size())
                engines[number] = engine;
        else
        {
                engine->time_stat = 0;
                engines.emplace_back(engine);
        }
 
        return number;
}
 
EngineContext* VM::GetFirstValidEngine()
{
        //returns the first valid (running) engine context
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                        return engines[i];
        }
        return 0;
}
 
void VM::CheckCamera()
{
        //if the camera is not active in the active engine,
        //switch the active engine to the next one that has an active camera
 
        if (active_engine->IsCameraActive() == false)
                active_engine = FindActiveEngine();
 
}
 
bool VM::StartEngine(EngineContext* engine, std::vector<Ogre::Camera*> &cameras)
{
        //start a sim engine
 
        Report("Initiating engine start");
        return engine->Start(cameras);
}
 
::SBS::SBS* VM::GetActiveSystem()
{
        //returns the active engine's SBS instance
 
        if (active_engine)
                return active_engine->GetSystem();
        return 0;
}
 
ScriptProcessor* VM::GetActiveScriptProcessor()
{
        //returns the active engine's script processor
 
        if (active_engine)
                return active_engine->GetScriptProcessor();
        return 0;
}
 
int VM::Run(std::vector<EngineContext*> &newengines)
{
        //run system
 
        //return codes are -1 for fatal error, 0 for failure, 1 for success, 2 to unload, and 3 to load new buildings
 
        SBS_PROFILE_MAIN("VM");
 
        //show progress dialog if needed
        //gui->ShowProgress();
 
        //get time for frame statistics
        unsigned long last = current_time;
        current_time = hal->GetCurrentTime();
 
        //run sim engines
        bool result = RunEngines(newengines);
 
        time_stat = hal->GetCurrentTime() - last;
 
        if (newengines.size() > 0)
                return 3;
 
        //delete an engine if requested
        HandleEngineShutdown();
 
        //exit if full shutdown request received
        if (Shutdown == true)
        {
                Shutdown = false;
                Report("Unloading due to shutdown request");
                return 2;
        }
 
        //exit if an engine failed to run, if it's either the only engine or if ConcurrentLoads is on
        if (result == false && (ConcurrentLoads == false || GetEngineCount() == 1))
                return 0;
 
        //don't continue if no available active engine
        if (!GetActiveEngine())
                return 0;
 
        //make sure active engine is the one the camera is active in
        CheckCamera();
 
        //exit if any engine is loading, unless RenderOnStartup is true
        if (IsEngineLoading() == true && RenderOnStartup == false)
                return 1;
 
        //if in CheckScript mode, exit
        if (CheckScript == true)
        {
                Report("Unloading to menu...");
                return 2;
        }
 
        //update Caelum
        skysystem->UpdateSky();
 
        //update OpenXR
        hal->UpdateOpenXR();
 
        //render graphics
        result = hal->Render();
        if (!result)
                return -1;
 
        //handle a building reload
        HandleReload();
 
        //handle behavior when a user exits an engine area
        SwitchEngines();
 
        //update first run status
        if (first_run == true)
                first_run = false;
 
        return 1;
}
 
bool VM::Load(bool clear, const std::string &filename, EngineContext *parent, const Vector3 &position, Real rotation, const Vector3 &area_min, const Vector3 &area_max)
{
        //load simulator and data file
 
        //exit if no building specified
        if (filename == "")
                return false;
 
        Report("Loading engine for building file '" + filename + "'...");
 
        //boot SBS
        EngineContext* engine = Initialize(clear, parent, position, rotation, area_min, area_max);
 
        //exit if init failed
        if (!engine)
                return false;
 
        //have new engine instance load building
        bool result = engine->Load(filename);
 
        //delete engine if load failed, if more than one engine is running
        if (result == false)
        {
                if (GetEngineCount() > 1)
                        DeleteEngine(engine);
                return false;
        }
 
        return true;
}
 
EngineContext* VM::Initialize(bool clear, EngineContext *parent, const Vector3 &position, Real rotation, const Vector3 &area_min, const Vector3 &area_max)
{
        //bootstrap simulator
 
        loadstart = true;
 
        if (GetEngineCount() == 0)
        {
                //set sky name
                skysystem->SkyName = hal->GetConfigString(hal->configfile, "Skyscraper.Frontend.Caelum.SkyName", "DefaultSky");
 
                //clear scene
                if (clear == true)
                        hal->ClearScene();
        }
 
        //clear screen
        try
        {
                hal->GetRenderWindow()->update();
        }
        catch (...)
        {
                ReportFatalError("Error updating render window");
                return 0;
        }
 
        //set parent to master engine, if not set
        if (parent == 0 && GetEngineCount() >= 1)
                parent = GetFirstValidEngine();
 
        //Create simulator instance
        EngineContext* engine = CreateEngine(parent, position, rotation, area_min, area_max);
 
        if (!GetActiveEngine())
                active_engine = engine;
 
        //set render on startup state
        //SetRenderOnStartup(hal->GetConfigBool(hal->configfile, "Skyscraper.SBS.RenderOnStartup", false));
 
        return engine;
}
 
void VM::Report(const std::string &message)
{
        hal->Report(message, "vm:");
}
 
bool VM::ReportError(const std::string &message)
{
        return hal->ReportError(message, "vm:");
}
 
bool VM::ReportFatalError(const std::string &message)
{
        return hal->ReportFatalError(message, "vm:");
}
 
#if OGRE_PLATFORM == OGRE_PLATFORM_APPLE
 
// Code to get OS version on Mac
int get_macos_version(uint32_t &major, uint32_t &minor, bool &osx)
{
        //returns the OS major and minor version
        //if osx is true, os is 10.x.x releases, otherwise is 11.x or greater
 
        char osversion[32];
        size_t osversion_len = sizeof(osversion) - 1;
        int osversion_name[] = { CTL_KERN, KERN_OSRELEASE };
 
        if (sysctl(osversion_name, 2, osversion, &osversion_len, NULL, 0) == -1) {
                printf("get_macos_version: sysctl() failed\n");
                return 1;
        }
 
        if (sscanf(osversion, "%u.%u", &major, &minor) != 2) {
                printf("get_macos_version: sscanf() failed\n");
                return 1;
        }
 
        if (major >= 20) {
                major -= 9;
                osx = false; //macOS 11 and newer
        } else {
                major -= 4;
                osx = true; //macOS 10.1.1 and newer
        }
 
        return 0;
}
 
#endif
 
void VM::ShowPlatform()
{
        //set platform name
 
#if OGRE_ARCH_TYPE == OGRE_ARCHITECTURE_32
        Bits = "32-bit";
#endif
#if OGRE_ARCH_TYPE == OGRE_ARCHITECTURE_64
        Bits = "64-bit";
#endif
 
#if OGRE_CPU == OGRE_CPU_X86
        Architecture = "x86";
#elif OGRE_CPU == OGRE_CPU_PPC
        Architecture = "PPC";
#elif OGRE_CPU == OGRE_CPU_ARM
        Architecture = "ARM";
#elif OGRE_CPU == OGRE_CPU_MIPS
        Architecture = "MIPS";
#elif OGRE_CPU == OGRE_CPU_UNKNOWN
        Architecture = "Unknown";
#endif
 
#if OGRE_PLATFORM == OGRE_PLATFORM_WIN32
        Platform = "Windows " + Architecture + " " + Bits;
#elif OGRE_PLATFORM == OGRE_PLATFORM_LINUX
        #ifdef  __FreeBSD__
                Platform = "FreeBSD " + Architecture + " " + Bits;
        #else
                Platform = "Linux " + Architecture + " " + Bits;
        #endif
#elif OGRE_PLATFORM == OGRE_PLATFORM_APPLE
        Platform = "MacOS " + Architecture + " " + Bits;
#endif
 
#if OGRE_PLATFORM == OGRE_PLATFORM_APPLE
        //report MacOS version if applicable
        uint32_t major = 0, minor = 0;
        bool osx = true;
        get_macos_version(major, minor, osx);
 
        if (osx == true)
        {
                GetHAL()->Report("Running on MacOS 10." + ToString((int)major) + "." + ToString((int)minor), "");
                macos_major = 10;
                macos_minor = (int)major;
        }
        else
        {
                GetHAL()->Report("Running on MacOS " + ToString((int)major) + "." + ToString((int)minor), "");
                macos_major = (int)major;
                macos_minor = (int)minor;
        }
#endif
 
#if OGRE_PLATFORM == OGRE_PLATFORM_WIN32
        //get Windows version
 
        NTSTATUS(WINAPI* RtlGetVersion)(LPOSVERSIONINFOEXW);
        OSVERSIONINFOEXW osInfo;
 
        *(FARPROC*)&RtlGetVersion = GetProcAddress(GetModuleHandleA("ntdll"), "RtlGetVersion");
 
        if (NULL != RtlGetVersion)
        {
                osInfo.dwOSVersionInfoSize = sizeof(osInfo);
                RtlGetVersion(&osInfo);
                GetHAL()->Report("Running on Microsoft Windows " + ToString((int)osInfo.dwMajorVersion) + "." + ToString((int)osInfo.dwMinorVersion), "");
        }
#endif
 
#if OGRE_PLATFORM == OGRE_PLATFORM_LINUX
        struct utsname osInfo{};
        uname(&osInfo);
        #ifdef  __FreeBSD__
                GetHAL()->Report("Running on FreeBSD " + std::string(osInfo.release), "");
        #else
                GetHAL()->Report("Running on Linux " + std::string(osInfo.release), "");
        #endif
#endif
}
 
wxWindow* VM::GetParent()
{
        //get parent WX window, this is assigned by the frontend
 
        return parent;
}
 
bool VM::UpdateProgress()
{
        //update progress based on total sim engine status
 
        int total_percent = GetEngineCount() * 100;
        int current_percent = 0;
 
        for (size_t i = 0; i < GetEngineCount(); i++)
        {
                if (GetEngine(i))
                        current_percent += GetEngine(i)->GetProgress();
        }
 
        int final = ((Real)current_percent / (Real)total_percent) * 100;
 
#ifdef USING_WX
        if (gui)
                return gui->UpdateProgress(final);
#endif
        return true;
}
 
bool VM::ReportMissingFiles(std::vector<std::string> &missing_files)
{
        //report missing files
#ifdef USING_WX
        if (gui)
                return gui->ReportMissingFiles(missing_files);
#endif
        return true;
}
 
void VM::StartConsole()
{
        //create VM console
        vmconsole = new VMConsole(this);
}
 
void VM::ProcessConsole()
{
        //if enabled, process console input
        if (vmconsole)
                vmconsole->Process();
 
}
 
VMConsole* VM::GetConsole()
{
        return vmconsole;
}
 
void VM::SetRenderOnStartup(bool value)
{
        RenderOnStartup = value;
 
        //override SBS startup render option, if specified
        for (int i = 0; i < engines.size(); i++)
        {
                if (engines[i])
                        engines[i]->GetSystem()->RenderOnStartup = value;
        }
}
 
bool VM::GetRenderOnStartup()
{
        return RenderOnStartup;
}
 
unsigned long VM::Uptime()
{
        //get uptime of VM in milliseconds
 
        return hal->GetCurrentTime();
}
 
unsigned long VM::GetElapsedTime(int instance)
{
        //get elapsed time (execution time) of the specified engine instance
 
        if (instance >= engines.size())
                return 0;
        return engines[instance]->time_stat;
}
 
void VM::ListPlayingSounds()
{
        //list playing sounds in all engines
 
        for (size_t i = 0; i < engines.size(); i++)
        {
                ::SBS::SBS* Simcore = engines[i]->GetSystem();
                
                if (Simcore)
                {
                        Report("Engine " + ToString(i) + ":");
                        Simcore->GetSoundSystem()->ShowPlayingSounds(false);
                        if (i == engines.size() - 1)
                                Simcore->GetSoundSystem()->ShowPlayingTotal();
                }
        }
}
 
}