c2588403c0
All service calls in the CTR OS return result codes indicating the success or failure of the call. Previous to this commit, Citra's HLE emulation of services and the kernel universally either ignored errors or returned dummy -1 error codes. This commit makes an initial effort to provide an infrastructure for error reporting and propagation which can be use going forward to make HLE calls accurately return errors as the original system. A few parts of the code have been updated to use the new system where applicable. One part of this effort is the definition of the `ResultCode` type, which provides facilities for constructing and parsing error codes in the structured format used by the CTR. The `ResultVal` type builds on `ResultCode` by providing a container for values returned by function that can report errors. It enforces that correct error checking will be done on function returns by preventing the use of the return value if the function returned an error code. Currently this change is mostly internal since errors are still suppressed on the ARM<->HLE border, as a temporary compatibility hack. As functionality is implemented and tested this hack can be eventually removed.
96 lines
3 KiB
C++
96 lines
3 KiB
C++
// Copyright 2014 Citra Emulator Project / PPSSPP Project
|
|
// Licensed under GPLv2
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include "common/common_types.h"
|
|
#include "core/hle/kernel/kernel.h"
|
|
#include "core/hle/result.h"
|
|
|
|
enum ThreadPriority {
|
|
THREADPRIO_HIGHEST = 0, ///< Highest thread priority
|
|
THREADPRIO_DEFAULT = 16, ///< Default thread priority for userland apps
|
|
THREADPRIO_LOW = 31, ///< Low range of thread priority for userland apps
|
|
THREADPRIO_LOWEST = 63, ///< Thread priority max checked by svcCreateThread
|
|
};
|
|
|
|
enum ThreadProcessorId {
|
|
THREADPROCESSORID_0 = 0xFFFFFFFE, ///< Enables core appcode
|
|
THREADPROCESSORID_1 = 0xFFFFFFFD, ///< Enables core syscore
|
|
THREADPROCESSORID_ALL = 0xFFFFFFFC, ///< Enables both cores
|
|
};
|
|
|
|
enum ThreadStatus {
|
|
THREADSTATUS_RUNNING = 1,
|
|
THREADSTATUS_READY = 2,
|
|
THREADSTATUS_WAIT = 4,
|
|
THREADSTATUS_SUSPEND = 8,
|
|
THREADSTATUS_DORMANT = 16,
|
|
THREADSTATUS_DEAD = 32,
|
|
THREADSTATUS_WAITSUSPEND = THREADSTATUS_WAIT | THREADSTATUS_SUSPEND
|
|
};
|
|
|
|
enum WaitType {
|
|
WAITTYPE_NONE,
|
|
WAITTYPE_SLEEP,
|
|
WAITTYPE_SEMA,
|
|
WAITTYPE_EVENT,
|
|
WAITTYPE_THREADEND,
|
|
WAITTYPE_VBLANK,
|
|
WAITTYPE_MUTEX,
|
|
WAITTYPE_SYNCH,
|
|
WAITTYPE_ARB,
|
|
};
|
|
|
|
namespace Kernel {
|
|
|
|
/// Creates a new thread - wrapper for external user
|
|
Handle CreateThread(const char* name, u32 entry_point, s32 priority, u32 arg, s32 processor_id,
|
|
u32 stack_top, int stack_size=Kernel::DEFAULT_STACK_SIZE);
|
|
|
|
/// Sets up the primary application thread
|
|
Handle SetupMainThread(s32 priority, int stack_size=Kernel::DEFAULT_STACK_SIZE);
|
|
|
|
/// Reschedules to the next available thread (call after current thread is suspended)
|
|
void Reschedule();
|
|
|
|
/// Stops the current thread
|
|
ResultCode StopThread(Handle thread, const char* reason);
|
|
|
|
/// Resumes a thread from waiting by marking it as "ready"
|
|
void ResumeThreadFromWait(Handle handle);
|
|
|
|
/// Arbitrate the highest priority thread that is waiting
|
|
Handle ArbitrateHighestPriorityThread(u32 arbiter, u32 address);
|
|
|
|
/// Arbitrate all threads currently waiting...
|
|
void ArbitrateAllThreads(u32 arbiter, u32 address);
|
|
|
|
/// Gets the current thread handle
|
|
Handle GetCurrentThreadHandle();
|
|
|
|
/**
|
|
* Puts the current thread in the wait state for the given type
|
|
* @param wait_type Type of wait
|
|
* @param wait_handle Handle of Kernel object that we are waiting on, defaults to current thread
|
|
*/
|
|
void WaitCurrentThread(WaitType wait_type, Handle wait_handle=GetCurrentThreadHandle());
|
|
|
|
/// Put current thread in a wait state - on WaitSynchronization
|
|
void WaitThread_Synchronization();
|
|
|
|
/// Get the priority of the thread specified by handle
|
|
ResultVal<u32> GetThreadPriority(const Handle handle);
|
|
|
|
/// Set the priority of the thread specified by handle
|
|
ResultCode SetThreadPriority(Handle handle, s32 priority);
|
|
|
|
/// Initialize threading
|
|
void ThreadingInit();
|
|
|
|
/// Shutdown threading
|
|
void ThreadingShutdown();
|
|
|
|
} // namespace
|