2020-02-24 18:04:12 -08:00
|
|
|
// Copyright 2020 yuzu Emulator Project
|
|
|
|
// Licensed under GPLv2 or any later version
|
2014-04-08 16:11:21 -07:00
|
|
|
// Refer to the license.txt file included.
|
2013-10-01 16:10:47 -07:00
|
|
|
|
2014-04-08 16:11:21 -07:00
|
|
|
#pragma once
|
2013-10-01 16:10:47 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
#include <atomic>
|
2018-08-05 19:07:28 -07:00
|
|
|
#include <chrono>
|
2016-09-20 08:21:23 -07:00
|
|
|
#include <functional>
|
2019-11-26 18:48:56 -08:00
|
|
|
#include <memory>
|
2022-04-07 16:01:26 -07:00
|
|
|
#include <mutex>
|
2019-09-09 18:37:29 -07:00
|
|
|
#include <optional>
|
2015-01-05 17:17:49 -08:00
|
|
|
#include <string>
|
2020-02-24 18:04:12 -08:00
|
|
|
#include <thread>
|
2019-02-14 09:42:58 -08:00
|
|
|
#include <vector>
|
2019-11-26 18:48:56 -08:00
|
|
|
|
2016-09-20 08:21:23 -07:00
|
|
|
#include "common/common_types.h"
|
2020-02-24 18:04:12 -08:00
|
|
|
#include "common/thread.h"
|
|
|
|
#include "common/wall_clock.h"
|
2015-01-05 17:17:49 -08:00
|
|
|
|
2019-02-12 09:32:15 -08:00
|
|
|
namespace Core::Timing {
|
2018-04-30 00:24:27 -07:00
|
|
|
|
2019-02-14 09:42:58 -08:00
|
|
|
/// A callback that may be scheduled for a particular core timing event.
|
2020-07-27 16:00:41 -07:00
|
|
|
using TimedCallback =
|
|
|
|
std::function<void(std::uintptr_t user_data, std::chrono::nanoseconds ns_late)>;
|
2018-08-05 18:27:11 -07:00
|
|
|
|
2019-02-14 09:42:58 -08:00
|
|
|
/// Contains the characteristics of a particular event.
|
|
|
|
struct EventType {
|
2020-11-25 12:21:03 -08:00
|
|
|
explicit EventType(TimedCallback&& callback_, std::string&& name_)
|
|
|
|
: callback{std::move(callback_)}, name{std::move(name_)} {}
|
2019-11-26 18:48:56 -08:00
|
|
|
|
2019-02-14 09:42:58 -08:00
|
|
|
/// The event's callback function.
|
|
|
|
TimedCallback callback;
|
|
|
|
/// A pointer to the name of the event.
|
2019-11-26 18:48:56 -08:00
|
|
|
const std::string name;
|
2019-02-14 09:42:58 -08:00
|
|
|
};
|
2015-01-05 17:17:49 -08:00
|
|
|
|
|
|
|
/**
|
2019-02-14 09:42:58 -08:00
|
|
|
* This is a system to schedule events into the emulated machine's future. Time is measured
|
|
|
|
* in main CPU clock cycles.
|
|
|
|
*
|
|
|
|
* To schedule an event, you first have to register its type. This is where you pass in the
|
2020-07-15 16:14:21 -07:00
|
|
|
* callback. You then schedule events using the type ID you get back.
|
2019-02-14 09:42:58 -08:00
|
|
|
*
|
2020-07-15 16:14:21 -07:00
|
|
|
* The s64 ns_late that the callbacks get is how many ns late it was.
|
2019-02-14 09:42:58 -08:00
|
|
|
* So to schedule a new event on a regular basis:
|
|
|
|
* inside callback:
|
2020-07-15 16:14:21 -07:00
|
|
|
* ScheduleEvent(period_in_ns - ns_late, callback, "whatever")
|
2017-11-25 05:56:57 -08:00
|
|
|
*/
|
2019-02-14 09:42:58 -08:00
|
|
|
class CoreTiming {
|
|
|
|
public:
|
|
|
|
CoreTiming();
|
|
|
|
~CoreTiming();
|
|
|
|
|
|
|
|
CoreTiming(const CoreTiming&) = delete;
|
|
|
|
CoreTiming(CoreTiming&&) = delete;
|
|
|
|
|
|
|
|
CoreTiming& operator=(const CoreTiming&) = delete;
|
|
|
|
CoreTiming& operator=(CoreTiming&&) = delete;
|
|
|
|
|
|
|
|
/// CoreTiming begins at the boundary of timing slice -1. An initial call to Advance() is
|
|
|
|
/// required to end slice - 1 and start slice 0 before the first cycle of code is executed.
|
2020-07-15 15:30:06 -07:00
|
|
|
void Initialize(std::function<void()>&& on_thread_init_);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
|
|
|
/// Tears down all timing related functionality.
|
|
|
|
void Shutdown();
|
|
|
|
|
2020-03-19 10:09:32 -07:00
|
|
|
/// Sets if emulation is multicore or single core, must be set before Initialize
|
2020-11-25 12:21:03 -08:00
|
|
|
void SetMulticore(bool is_multicore_) {
|
|
|
|
is_multicore = is_multicore_;
|
2020-03-19 10:09:32 -07:00
|
|
|
}
|
|
|
|
|
2020-05-29 14:37:57 -07:00
|
|
|
/// Check if it's using host timing.
|
|
|
|
bool IsHostTiming() const {
|
|
|
|
return is_multicore;
|
|
|
|
}
|
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Pauses/Unpauses the execution of the timer thread.
|
|
|
|
void Pause(bool is_paused);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Pauses/Unpauses the execution of the timer thread and waits until paused.
|
|
|
|
void SyncPause(bool is_paused);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Checks if core timing is running.
|
|
|
|
bool IsRunning() const;
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Checks if the timer thread has started.
|
|
|
|
bool HasStarted() const {
|
|
|
|
return has_started;
|
|
|
|
}
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Checks if there are any pending time events.
|
|
|
|
bool HasPendingEvents() const;
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Schedules an event in core timing
|
2020-07-15 15:30:06 -07:00
|
|
|
void ScheduleEvent(std::chrono::nanoseconds ns_into_future,
|
2020-07-27 16:00:41 -07:00
|
|
|
const std::shared_ptr<EventType>& event_type, std::uintptr_t user_data = 0);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-07-27 16:00:41 -07:00
|
|
|
void UnscheduleEvent(const std::shared_ptr<EventType>& event_type, std::uintptr_t user_data);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// We only permit one event of each type in the queue at a time.
|
|
|
|
void RemoveEvent(const std::shared_ptr<EventType>& event_type);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2021-05-02 19:14:15 -07:00
|
|
|
void AddTicks(u64 ticks_to_add);
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-03-28 12:23:28 -07:00
|
|
|
void ResetTicks();
|
|
|
|
|
|
|
|
void Idle();
|
|
|
|
|
|
|
|
s64 GetDowncount() const {
|
|
|
|
return downcount;
|
|
|
|
}
|
2019-02-14 09:42:58 -08:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Returns current time in emulated CPU cycles
|
|
|
|
u64 GetCPUTicks() const;
|
2019-09-09 18:37:29 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Returns current time in emulated in Clock cycles
|
|
|
|
u64 GetClockTicks() const;
|
2019-09-09 18:37:29 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Returns current time in microseconds.
|
|
|
|
std::chrono::microseconds GetGlobalTimeUs() const;
|
2019-09-09 18:37:29 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Returns current time in nanoseconds.
|
|
|
|
std::chrono::nanoseconds GetGlobalTimeNs() const;
|
2019-09-09 18:37:29 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
/// Checks for events manually and returns time in nanoseconds for next event, threadsafe.
|
2020-03-03 11:50:38 -08:00
|
|
|
std::optional<s64> Advance();
|
2019-02-14 09:42:58 -08:00
|
|
|
|
|
|
|
private:
|
|
|
|
struct Event;
|
|
|
|
|
|
|
|
/// Clear all pending events. This should ONLY be done on exit.
|
|
|
|
void ClearPendingEvents();
|
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
static void ThreadEntry(CoreTiming& instance);
|
|
|
|
void ThreadLoop();
|
|
|
|
|
|
|
|
std::unique_ptr<Common::WallClock> clock;
|
2019-09-09 18:37:29 -07:00
|
|
|
|
2020-02-24 18:04:12 -08:00
|
|
|
u64 global_timer = 0;
|
2019-02-14 09:42:58 -08:00
|
|
|
|
|
|
|
// The queue is a min-heap using std::make_heap/push_heap/pop_heap.
|
|
|
|
// We don't use std::priority_queue because we need to be able to serialize, unserialize and
|
|
|
|
// erase arbitrary events (RemoveEvent()) regardless of the queue order. These aren't
|
|
|
|
// accomodated by the standard adaptor class.
|
|
|
|
std::vector<Event> event_queue;
|
|
|
|
u64 event_fifo_id = 0;
|
|
|
|
|
2019-11-26 18:48:56 -08:00
|
|
|
std::shared_ptr<EventType> ev_lost;
|
2020-02-24 18:04:12 -08:00
|
|
|
Common::Event event{};
|
2020-02-25 08:28:55 -08:00
|
|
|
Common::Event pause_event{};
|
2022-04-07 16:01:26 -07:00
|
|
|
std::mutex basic_lock;
|
|
|
|
std::mutex advance_lock;
|
2020-02-24 18:04:12 -08:00
|
|
|
std::unique_ptr<std::thread> timer_thread;
|
|
|
|
std::atomic<bool> paused{};
|
|
|
|
std::atomic<bool> paused_set{};
|
|
|
|
std::atomic<bool> wait_set{};
|
|
|
|
std::atomic<bool> shutting_down{};
|
|
|
|
std::atomic<bool> has_started{};
|
2020-07-15 15:30:06 -07:00
|
|
|
std::function<void()> on_thread_init{};
|
2020-02-24 18:04:12 -08:00
|
|
|
|
2020-03-19 10:09:32 -07:00
|
|
|
bool is_multicore{};
|
|
|
|
|
2020-03-28 12:23:28 -07:00
|
|
|
/// Cycle timing
|
|
|
|
u64 ticks{};
|
|
|
|
s64 downcount{};
|
2019-02-14 09:42:58 -08:00
|
|
|
};
|
2013-10-01 16:10:47 -07:00
|
|
|
|
2019-11-26 18:48:56 -08:00
|
|
|
/// Creates a core timing event with the given name and callback.
|
|
|
|
///
|
|
|
|
/// @param name The name of the core timing event to create.
|
|
|
|
/// @param callback The callback to execute for the event.
|
|
|
|
///
|
|
|
|
/// @returns An EventType instance representing the created event.
|
|
|
|
///
|
|
|
|
std::shared_ptr<EventType> CreateEvent(std::string name, TimedCallback&& callback);
|
|
|
|
|
2019-02-12 09:32:15 -08:00
|
|
|
} // namespace Core::Timing
|