DataHearth/yuzu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

core: Make use of [[nodiscard]] with the System class

Browse Source 
Given this is a central class, we should flag cases where the return
value of some functions not being used is likely a bug.
This commit is contained in:
Lioncash 2020-11-18 02:06:42 -05:00
parent abda366362
commit bcaadac22c
4 changed files with 82 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/core/core.cpp
View File

@ -632,7 +632,11 @@ const std::string& System::GetStatusDetails() const {
return impl->status_details; return impl->status_details;
} }
Loader::AppLoader& System::GetAppLoader() const { Loader::AppLoader& System::GetAppLoader() {
return *impl->app_loader;
}
const Loader::AppLoader& System::GetAppLoader() const {
return *impl->app_loader; return *impl->app_loader;
} }

153
src/core/core.h
View File

@ -144,19 +144,19 @@ public:
* Run the OS and Application * Run the OS and Application
* This function will start emulation and run the relevant devices * This function will start emulation and run the relevant devices
*/ */
ResultStatus Run(); [[nodiscard]] ResultStatus Run();
/** /**
* Pause the OS and Application * Pause the OS and Application
* This function will pause emulation and stop the relevant devices * This function will pause emulation and stop the relevant devices
*/ */
ResultStatus Pause(); [[nodiscard]] ResultStatus Pause();
/** /**
* Step the CPU one instruction * Step the CPU one instruction
* @return Result status, indicating whether or not the operation succeeded. * @return Result status, indicating whether or not the operation succeeded.
*/ */
ResultStatus SingleStep(); [[nodiscard]] ResultStatus SingleStep();
/** /**
* Invalidate the CPU instruction caches * Invalidate the CPU instruction caches
@ -175,20 +175,20 @@ public:
* @param filepath String path to the executable application to load on the host file system. * @param filepath String path to the executable application to load on the host file system.
* @returns ResultStatus code, indicating if the operation succeeded. * @returns ResultStatus code, indicating if the operation succeeded.
*/ */
ResultStatus Load(Frontend::EmuWindow& emu_window, const std::string& filepath); [[nodiscard]] ResultStatus Load(Frontend::EmuWindow& emu_window, const std::string& filepath);
/** /**
* Indicates if the emulated system is powered on (all subsystems initialized and able to run an * Indicates if the emulated system is powered on (all subsystems initialized and able to run an
* application). * application).
* @returns True if the emulated system is powered on, otherwise false. * @returns True if the emulated system is powered on, otherwise false.
*/ */
bool IsPoweredOn() const; [[nodiscard]] bool IsPoweredOn() const;
/// Gets a reference to the telemetry session for this emulation session. /// Gets a reference to the telemetry session for this emulation session.
Core::TelemetrySession& TelemetrySession(); [[nodiscard]] Core::TelemetrySession& TelemetrySession();
/// Gets a reference to the telemetry session for this emulation session. /// Gets a reference to the telemetry session for this emulation session.
const Core::TelemetrySession& TelemetrySession() const; [[nodiscard]] const Core::TelemetrySession& TelemetrySession() const;
/// Prepare the core emulation for a reschedule /// Prepare the core emulation for a reschedule
void PrepareReschedule(); void PrepareReschedule();
@ -197,185 +197,178 @@ public:
void PrepareReschedule(u32 core_index); void PrepareReschedule(u32 core_index);
/// Gets and resets core performance statistics /// Gets and resets core performance statistics
PerfStatsResults GetAndResetPerfStats(); [[nodiscard]] PerfStatsResults GetAndResetPerfStats();
/// Gets an ARM interface to the CPU core that is currently running /// Gets an ARM interface to the CPU core that is currently running
ARM_Interface& CurrentArmInterface(); [[nodiscard]] ARM_Interface& CurrentArmInterface();
/// Gets an ARM interface to the CPU core that is currently running /// Gets an ARM interface to the CPU core that is currently running
const ARM_Interface& CurrentArmInterface() const; [[nodiscard]] const ARM_Interface& CurrentArmInterface() const;
/// Gets the index of the currently running CPU core /// Gets the index of the currently running CPU core
std::size_t CurrentCoreIndex() const; [[nodiscard]] std::size_t CurrentCoreIndex() const;
/// Gets the scheduler for the CPU core that is currently running /// Gets the scheduler for the CPU core that is currently running
Kernel::Scheduler& CurrentScheduler(); [[nodiscard]] Kernel::Scheduler& CurrentScheduler();
/// Gets the scheduler for the CPU core that is currently running /// Gets the scheduler for the CPU core that is currently running
const Kernel::Scheduler& CurrentScheduler() const; [[nodiscard]] const Kernel::Scheduler& CurrentScheduler() const;
/// Gets the physical core for the CPU core that is currently running /// Gets the physical core for the CPU core that is currently running
Kernel::PhysicalCore& CurrentPhysicalCore(); [[nodiscard]] Kernel::PhysicalCore& CurrentPhysicalCore();
/// Gets the physical core for the CPU core that is currently running /// Gets the physical core for the CPU core that is currently running
const Kernel::PhysicalCore& CurrentPhysicalCore() const; [[nodiscard]] const Kernel::PhysicalCore& CurrentPhysicalCore() const;
/// Gets a reference to an ARM interface for the CPU core with the specified index /// Gets a reference to an ARM interface for the CPU core with the specified index
ARM_Interface& ArmInterface(std::size_t core_index); [[nodiscard]] ARM_Interface& ArmInterface(std::size_t core_index);
/// Gets a const reference to an ARM interface from the CPU core with the specified index /// Gets a const reference to an ARM interface from the CPU core with the specified index
const ARM_Interface& ArmInterface(std::size_t core_index) const; [[nodiscard]] const ARM_Interface& ArmInterface(std::size_t core_index) const;
CpuManager& GetCpuManager(); /// Gets a reference to the underlying CPU manager.
[[nodiscard]] CpuManager& GetCpuManager();
const CpuManager& GetCpuManager() const; /// Gets a const reference to the underlying CPU manager
[[nodiscard]] const CpuManager& GetCpuManager() const;
/// Gets a reference to the exclusive monitor /// Gets a reference to the exclusive monitor
ExclusiveMonitor& Monitor(); [[nodiscard]] ExclusiveMonitor& Monitor();
/// Gets a constant reference to the exclusive monitor /// Gets a constant reference to the exclusive monitor
const ExclusiveMonitor& Monitor() const; [[nodiscard]] const ExclusiveMonitor& Monitor() const;
/// Gets a mutable reference to the system memory instance. /// Gets a mutable reference to the system memory instance.
Core::Memory::Memory& Memory(); [[nodiscard]] Core::Memory::Memory& Memory();
/// Gets a constant reference to the system memory instance. /// Gets a constant reference to the system memory instance.
const Core::Memory::Memory& Memory() const; [[nodiscard]] const Core::Memory::Memory& Memory() const;
/// Gets a mutable reference to the GPU interface /// Gets a mutable reference to the GPU interface
Tegra::GPU& GPU(); [[nodiscard]] Tegra::GPU& GPU();
/// Gets an immutable reference to the GPU interface. /// Gets an immutable reference to the GPU interface.
const Tegra::GPU& GPU() const; [[nodiscard]] const Tegra::GPU& GPU() const;
/// Gets a mutable reference to the renderer. /// Gets a mutable reference to the renderer.
VideoCore::RendererBase& Renderer(); [[nodiscard]] VideoCore::RendererBase& Renderer();
/// Gets an immutable reference to the renderer. /// Gets an immutable reference to the renderer.
const VideoCore::RendererBase& Renderer() const; [[nodiscard]] const VideoCore::RendererBase& Renderer() const;
/// Gets the scheduler for the CPU core with the specified index /// Gets the scheduler for the CPU core with the specified index
Kernel::Scheduler& Scheduler(std::size_t core_index); [[nodiscard]] Kernel::Scheduler& Scheduler(std::size_t core_index);
/// Gets the scheduler for the CPU core with the specified index /// Gets the scheduler for the CPU core with the specified index
const Kernel::Scheduler& Scheduler(std::size_t core_index) const; [[nodiscard]] const Kernel::Scheduler& Scheduler(std::size_t core_index) const;
/// Gets the global scheduler /// Gets the global scheduler
Kernel::GlobalScheduler& GlobalScheduler(); [[nodiscard]] Kernel::GlobalScheduler& GlobalScheduler();
/// Gets the global scheduler /// Gets the global scheduler
const Kernel::GlobalScheduler& GlobalScheduler() const; [[nodiscard]] const Kernel::GlobalScheduler& GlobalScheduler() const;
/// Gets the manager for the guest device memory /// Gets the manager for the guest device memory
Core::DeviceMemory& DeviceMemory(); [[nodiscard]] Core::DeviceMemory& DeviceMemory();
/// Gets the manager for the guest device memory /// Gets the manager for the guest device memory
const Core::DeviceMemory& DeviceMemory() const; [[nodiscard]] const Core::DeviceMemory& DeviceMemory() const;
/// Provides a pointer to the current process /// Provides a pointer to the current process
Kernel::Process* CurrentProcess(); [[nodiscard]] Kernel::Process* CurrentProcess();
/// Provides a constant pointer to the current process. /// Provides a constant pointer to the current process.
const Kernel::Process* CurrentProcess() const; [[nodiscard]] const Kernel::Process* CurrentProcess() const;
/// Provides a reference to the core timing instance. /// Provides a reference to the core timing instance.
Timing::CoreTiming& CoreTiming(); [[nodiscard]] Timing::CoreTiming& CoreTiming();
/// Provides a constant reference to the core timing instance. /// Provides a constant reference to the core timing instance.
const Timing::CoreTiming& CoreTiming() const; [[nodiscard]] const Timing::CoreTiming& CoreTiming() const;
/// Provides a reference to the interrupt manager instance. /// Provides a reference to the interrupt manager instance.
Core::Hardware::InterruptManager& InterruptManager(); [[nodiscard]] Core::Hardware::InterruptManager& InterruptManager();
/// Provides a constant reference to the interrupt manager instance. /// Provides a constant reference to the interrupt manager instance.
const Core::Hardware::InterruptManager& InterruptManager() const; [[nodiscard]] const Core::Hardware::InterruptManager& InterruptManager() const;
/// Provides a reference to the kernel instance. /// Provides a reference to the kernel instance.
Kernel::KernelCore& Kernel(); [[nodiscard]] Kernel::KernelCore& Kernel();
/// Provides a constant reference to the kernel instance. /// Provides a constant reference to the kernel instance.
const Kernel::KernelCore& Kernel() const; [[nodiscard]] const Kernel::KernelCore& Kernel() const;
/// Provides a reference to the internal PerfStats instance. /// Provides a reference to the internal PerfStats instance.
Core::PerfStats& GetPerfStats(); [[nodiscard]] Core::PerfStats& GetPerfStats();
/// Provides a constant reference to the internal PerfStats instance. /// Provides a constant reference to the internal PerfStats instance.
const Core::PerfStats& GetPerfStats() const; [[nodiscard]] const Core::PerfStats& GetPerfStats() const;
/// Provides a reference to the frame limiter; /// Provides a reference to the frame limiter;
Core::FrameLimiter& FrameLimiter(); [[nodiscard]] Core::FrameLimiter& FrameLimiter();
/// Provides a constant referent to the frame limiter /// Provides a constant referent to the frame limiter
const Core::FrameLimiter& FrameLimiter() const; [[nodiscard]] const Core::FrameLimiter& FrameLimiter() const;
/// Gets the name of the current game /// Gets the name of the current game
Loader::ResultStatus GetGameName(std::string& out) const; [[nodiscard]] Loader::ResultStatus GetGameName(std::string& out) const;
void SetStatus(ResultStatus new_status, const char* details); void SetStatus(ResultStatus new_status, const char* details);
const std::string& GetStatusDetails() const; [[nodiscard]] const std::string& GetStatusDetails() const;
Loader::AppLoader& GetAppLoader() const; [[nodiscard]] Loader::AppLoader& GetAppLoader();
[[nodiscard]] const Loader::AppLoader& GetAppLoader() const;
Service::SM::ServiceManager& ServiceManager(); [[nodiscard]] Service::SM::ServiceManager& ServiceManager();
const Service::SM::ServiceManager& ServiceManager() const; [[nodiscard]] const Service::SM::ServiceManager& ServiceManager() const;
void SetFilesystem(FileSys::VirtualFilesystem vfs); void SetFilesystem(FileSys::VirtualFilesystem vfs);
FileSys::VirtualFilesystem GetFilesystem() const; [[nodiscard]] FileSys::VirtualFilesystem GetFilesystem() const;
void RegisterCheatList(const std::vector<Memory::CheatEntry>& list, void RegisterCheatList(const std::vector<Memory::CheatEntry>& list,
const std::array<u8, 0x20>& build_id, VAddr main_region_begin, const std::array<u8, 0x20>& build_id, VAddr main_region_begin,
u64 main_region_size); u64 main_region_size);
void SetAppletFrontendSet(Service::AM::Applets::AppletFrontendSet&& set); void SetAppletFrontendSet(Service::AM::Applets::AppletFrontendSet&& set);
void SetDefaultAppletFrontendSet(); void SetDefaultAppletFrontendSet();
Service::AM::Applets::AppletManager& GetAppletManager(); [[nodiscard]] Service::AM::Applets::AppletManager& GetAppletManager();
[[nodiscard]] const Service::AM::Applets::AppletManager& GetAppletManager() const;
const Service::AM::Applets::AppletManager& GetAppletManager() const;
void SetContentProvider(std::unique_ptr<FileSys::ContentProviderUnion> provider); void SetContentProvider(std::unique_ptr<FileSys::ContentProviderUnion> provider);
FileSys::ContentProvider& GetContentProvider(); [[nodiscard]] FileSys::ContentProvider& GetContentProvider();
[[nodiscard]] const FileSys::ContentProvider& GetContentProvider() const;
const FileSys::ContentProvider& GetContentProvider() const; [[nodiscard]] Service::FileSystem::FileSystemController& GetFileSystemController();
[[nodiscard]] const Service::FileSystem::FileSystemController& GetFileSystemController() const;
Service::FileSystem::FileSystemController& GetFileSystemController();
const Service::FileSystem::FileSystemController& GetFileSystemController() const;
void RegisterContentProvider(FileSys::ContentProviderUnionSlot slot, void RegisterContentProvider(FileSys::ContentProviderUnionSlot slot,
FileSys::ContentProvider* provider); FileSys::ContentProvider* provider);
void ClearContentProvider(FileSys::ContentProviderUnionSlot slot); void ClearContentProvider(FileSys::ContentProviderUnionSlot slot);
const Reporter& GetReporter() const; [[nodiscard]] const Reporter& GetReporter() const;
Service::Glue::ARPManager& GetARPManager(); [[nodiscard]] Service::Glue::ARPManager& GetARPManager();
[[nodiscard]] const Service::Glue::ARPManager& GetARPManager() const;
const Service::Glue::ARPManager& GetARPManager() const; [[nodiscard]] Service::APM::Controller& GetAPMController();
[[nodiscard]] const Service::APM::Controller& GetAPMController() const;
Service::APM::Controller& GetAPMController(); [[nodiscard]] Service::LM::Manager& GetLogManager();
[[nodiscard]] const Service::LM::Manager& GetLogManager() const;
const Service::APM::Controller& GetAPMController() const; [[nodiscard]] Service::Time::TimeManager& GetTimeManager();
[[nodiscard]] const Service::Time::TimeManager& GetTimeManager() const;
Service::LM::Manager& GetLogManager();
const Service::LM::Manager& GetLogManager() const;
Service::Time::TimeManager& GetTimeManager();
const Service::Time::TimeManager& GetTimeManager() const;
void SetExitLock(bool locked); void SetExitLock(bool locked);
[[nodiscard]] bool GetExitLock() const;
bool GetExitLock() const;
void SetCurrentProcessBuildID(const CurrentBuildProcessID& id); void SetCurrentProcessBuildID(const CurrentBuildProcessID& id);
[[nodiscard]] const CurrentBuildProcessID& GetCurrentProcessBuildID() const;
const CurrentBuildProcessID& GetCurrentProcessBuildID() const;
/// Register a host thread as an emulated CPU Core. /// Register a host thread as an emulated CPU Core.
void RegisterCoreThread(std::size_t id); void RegisterCoreThread(std::size_t id);
@ -390,7 +383,7 @@ public:
void ExitDynarmicProfile(); void ExitDynarmicProfile();
/// Tells if system is running on multicore. /// Tells if system is running on multicore.
bool IsMulticore() const; [[nodiscard]] bool IsMulticore() const;
private: private:
System(); System();
@ -401,7 +394,7 @@ private:
* input. * input.
* @return ResultStatus code, indicating if the operation succeeded. * @return ResultStatus code, indicating if the operation succeeded.
*/ */
ResultStatus Init(Frontend::EmuWindow& emu_window); [[nodiscard]] ResultStatus Init(Frontend::EmuWindow& emu_window);
struct Impl; struct Impl;
std::unique_ptr<Impl> impl; std::unique_ptr<Impl> impl;

4
src/yuzu_cmd/yuzu.cpp
View File

@ -240,11 +240,11 @@ int main(int argc, char** argv) {
system.CurrentProcess()->GetTitleID(), false, system.CurrentProcess()->GetTitleID(), false,
[](VideoCore::LoadCallbackStage, size_t value, size_t total) {}); [](VideoCore::LoadCallbackStage, size_t value, size_t total) {});
system.Run(); void(system.Run());
while (emu_window->IsOpen()) { while (emu_window->IsOpen()) {
std::this_thread::sleep_for(std::chrono::milliseconds(1)); std::this_thread::sleep_for(std::chrono::milliseconds(1));
} }
system.Pause(); void(system.Pause());
system.Shutdown(); system.Shutdown();
detached_tasks.WaitForAllTasks(); detached_tasks.WaitForAllTasks();

4
src/yuzu_tester/yuzu.cpp
View File

@ -256,11 +256,11 @@ int main(int argc, char** argv) {
system.GPU().Start(); system.GPU().Start();
system.Run(); void(system.Run());
while (!finished) { while (!finished) {
std::this_thread::sleep_for(std::chrono::milliseconds(1)); std::this_thread::sleep_for(std::chrono::milliseconds(1));
} }
system.Pause(); void(system.Pause());
detached_tasks.WaitForAllTasks(); detached_tasks.WaitForAllTasks();
return return_value; return return_value;