mirror of
https://github.com/Atmosphere-NX/Atmosphere.git
synced 2025-06-03 08:08:39 -04:00
fs: implement AccessLog, enable for File operations
This commit is contained in:
Michael Scire
SciresM
parent
3fe7700e5c
commit
e2b17086d4
36 changed files with 1930 additions and 362 deletions
|
|
@ -0,0 +1,153 @@
|
|||
/*
|
||||
* Copyright (c) 2018-2020 Atmosphère-NX
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms and conditions of the GNU General Public License,
|
||||
* version 2, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope 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, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#pragma once
|
||||
#include <vapours.hpp>
|
||||
#include <stratosphere/fs/fs_access_log.hpp>
|
||||
#include <stratosphere/fs/fs_directory.hpp>
|
||||
#include <stratosphere/fs/fs_file.hpp>
|
||||
#include <stratosphere/fs/fs_priority.hpp>
|
||||
#include <stratosphere/os/os_tick.hpp>
|
||||
|
||||
namespace ams::fs::impl {
|
||||
|
||||
enum AccessLogTarget : u32 {
|
||||
AccessLogTarget_None = (0 << 0),
|
||||
AccessLogTarget_Application = (1 << 0),
|
||||
AccessLogTarget_System = (1 << 1),
|
||||
};
|
||||
|
||||
struct IdentifyAccessLogHandle {
|
||||
void *handle;
|
||||
public:
|
||||
static constexpr IdentifyAccessLogHandle MakeHandle(void *h) {
|
||||
return IdentifyAccessLogHandle{h};
|
||||
}
|
||||
};
|
||||
|
||||
bool IsEnabledAccessLog(u32 target);
|
||||
bool IsEnabledAccessLog();
|
||||
|
||||
bool IsEnabledHandleAccessLog(fs::FileHandle handle);
|
||||
bool IsEnabledHandleAccessLog(fs::DirectoryHandle handle);
|
||||
bool IsEnabledHandleAccessLog(fs::impl::IdentifyAccessLogHandle handle);
|
||||
bool IsEnabledHandleAccessLog(const void *handle);
|
||||
|
||||
bool IsEnabledFileSystemAccessorAccessLog(const char *mount_name);
|
||||
void EnableFileSystemAccessorAccessLog(const char *mount_name);
|
||||
|
||||
using AccessLogPrinterCallback = int (*)(char *buffer, size_t buffer_size);
|
||||
void RegisterStartAccessLogPrinterCallback(AccessLogPrinterCallback callback);
|
||||
|
||||
void OutputAccessLog(Result result, os::Tick start, os::Tick end, const char *name, fs::FileHandle handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLog(Result result, os::Tick start, os::Tick end, const char *name, fs::DirectoryHandle handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLog(Result result, os::Tick start, os::Tick end, const char *name, fs::impl::IdentifyAccessLogHandle handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLog(Result result, os::Tick start, os::Tick end, const char *name, const void *handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLog(Result result, fs::Priority priority, os::Tick start, os::Tick end, const char *name, const void *handle, const char *fmt, ...) __attribute__((format (printf, 7, 8)));
|
||||
void OutputAccessLog(Result result, fs::PriorityRaw priority_raw, os::Tick start, os::Tick end, const char *name, const void *handle, const char *fmt, ...) __attribute__((format (printf, 7, 8)));
|
||||
|
||||
void OutputAccessLogToOnlySdCard(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
|
||||
|
||||
void OutputAccessLogUnlessResultSuccess(Result result, os::Tick start, os::Tick end, const char *name, fs::FileHandle handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLogUnlessResultSuccess(Result result, os::Tick start, os::Tick end, const char *name, fs::DirectoryHandle handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
void OutputAccessLogUnlessResultSuccess(Result result, os::Tick start, os::Tick end, const char *name, const void *handle, const char *fmt, ...) __attribute__((format (printf, 6, 7)));
|
||||
|
||||
class IdString {
|
||||
private:
|
||||
char buffer[0x20];
|
||||
private:
|
||||
const char *ToValueString(int id);
|
||||
public:
|
||||
template<typename T>
|
||||
const char *ToString(T id);
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
/* Access log components. */
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_SIZE ", size: %" PRId64 ""
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_OFFSET_AND_SIZE ", offset: %" PRId64 ", size: %zu"
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_THREAD_ID ", thread_id: %" PRIu64 ""
|
||||
|
||||
/* Access log formats. */
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_NONE ""
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE_WITH_NO_OPTION AMS_FS_IMPL_ACCESS_LOG_FORMAT_OFFSET_AND_SIZE
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE_WITH_FLUSH_OPTION AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE_WITH_NO_OPTION ", write_option: Flush"
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE(__OPTION__) ((__OPTION__).HasFlushFlag() ? AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE_WITH_FLUSH_OPTION : AMS_FS_IMPL_ACCESS_LOG_FORMAT_WRITE_FILE_WITH_NO_OPTION)
|
||||
|
||||
/* Access log invocation lambdas. */
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_IMPL(__EXPR__, __HANDLE__, __ENABLED__, __NAME__, ...) \
|
||||
[&](const char *name) { \
|
||||
if (!(__ENABLED__)) { \
|
||||
return (__EXPR__); \
|
||||
} else { \
|
||||
const ::ams::os::Tick start = ::ams::os::GetSystemTick(); \
|
||||
const auto result = (__EXPR__); \
|
||||
const ::ams::os::Tick end = ::ams::os::GetSystemTick(); \
|
||||
::ams::fs::impl::OutputAccessLog(result, start, end, name, __HANDLE__, __VA_ARGS__); \
|
||||
return result; \
|
||||
} \
|
||||
}(__NAME__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_WITH_PRIORITY_IMPL(__EXPR__, __PRIORITY__, __HANDLE__, __ENABLED__, __NAME__, ...) \
|
||||
[&](const char *name) { \
|
||||
if (!(__ENABLED__)) { \
|
||||
return (__EXPR__); \
|
||||
} else { \
|
||||
const ::ams::os::Tick start = ::ams::os::GetSystemTick(); \
|
||||
const auto result = (__EXPR__); \
|
||||
const ::ams::os::Tick end = ::ams::os::GetSystemTick(); \
|
||||
::ams::fs::impl::OutputAccessLog(result, __PRIORITY__, start, end, name, __HANDLE__, __VA_ARGS__); \
|
||||
return result; \
|
||||
} \
|
||||
}(__NAME__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_EXPLICIT_IMPL(__RESULT__, __START__, __END__, __HANDLE__, __ENABLED__, __NAME__, ...) \
|
||||
[&](const char *name) { \
|
||||
if (!(__ENABLED__)) { \
|
||||
return __RESULT__; \
|
||||
} else { \
|
||||
::ams::fs::impl::OutputAccessLog(__RESULT__, __START__, __END__, name, __HANDLE__, __VA_ARGS__); \
|
||||
return __RESULT__; \
|
||||
} \
|
||||
}(__NAME__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_UNLESS_R_SUCCEEDED_IMPL(__EXPR__, __ENABLED__, __NAME__, ...) \
|
||||
[&](const char *name) { \
|
||||
if (!(__ENABLED__)) { \
|
||||
return (__EXPR__); \
|
||||
} else { \
|
||||
const ::ams::os::Tick start = ::ams::os::GetSystemTick(); \
|
||||
const auto result = (__EXPR__); \
|
||||
const ::ams::os::Tick end = ::ams::os::GetSystemTick(); \
|
||||
::ams::fs::impl::OutputAccessLogUnlessResultSuccess(result, start, end, name, nullptr, __VA_ARGS__); \
|
||||
return result; \
|
||||
} \
|
||||
}(__NAME__)
|
||||
|
||||
|
||||
/* Access log api. */
|
||||
#define AMS_FS_IMPL_ACCESS_LOG(__EXPR__, __HANDLE__, ...) \
|
||||
AMS_FS_IMPL_ACCESS_LOG_IMPL((__EXPR__), __HANDLE__, ::ams::fs::impl::IsEnabledAccessLog() && ::ams::fs::impl::IsEnabledHandleAccessLog(__HANDLE__), AMS_CURRENT_FUNCTION_NAME, __VA_ARGS__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_WITH_NAME(__EXPR__, __HANDLE__, __NAME__, ...) \
|
||||
AMS_FS_IMPL_ACCESS_LOG_IMPL((__EXPR__), __HANDLE__, ::ams::fs::impl::IsEnabledAccessLog() && ::ams::fs::impl::IsEnabledHandleAccessLog(__HANDLE__), __NAME__, __VA_ARGS__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_EXPLICIT(__RESULT__, __START__, __END__, __HANDLE__, __NAME__, ...) \
|
||||
AMS_FS_IMPL_ACCESS_LOG_EXPLICIT_IMPL((__RESULT__), __START__, __END__, __HANDLE__, ::ams::fs::impl::IsEnabledAccessLog() && ::ams::fs::impl::IsEnabledHandleAccessLog(__HANDLE__), __NAME__, __VA_ARGS__)
|
||||
|
||||
#define AMS_FS_IMPL_ACCESS_LOG_UNLESS_R_SUCCEEDED(__EXPR__, ...) \
|
||||
AMS_FS_IMPL_ACCESS_LOG_UNLESS_R_SUCCEEDED_IMPL((__EXPR__), ::ams::fs::impl::IsEnabledAccessLog(), AMS_CURRENT_FUNCTION_NAME, __VA_ARGS__)
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
/*
|
||||
* Copyright (c) 2018-2020 Atmosphère-NX
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms and conditions of the GNU General Public License,
|
||||
* version 2, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope 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, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#pragma once
|
||||
#include <stratosphere/fs/fs_common.hpp>
|
||||
#include <stratosphere/sf/sf_fs_inline_context.hpp>
|
||||
|
||||
namespace ams::fs::impl {
|
||||
|
||||
constexpr inline u8 TlsIoPriorityMask = 0x7;
|
||||
constexpr inline u8 TlsIoRecursiveCallMask = 0x8;
|
||||
|
||||
struct TlsIoValueForInheritance {
|
||||
u8 _tls_value;
|
||||
};
|
||||
|
||||
inline void SetCurrentRequestRecursive() {
|
||||
os::ThreadType * const cur_thread = os::GetCurrentThread();
|
||||
sf::SetFsInlineContext(cur_thread, TlsIoRecursiveCallMask | sf::GetFsInlineContext(cur_thread));
|
||||
}
|
||||
|
||||
inline bool IsCurrentRequestRecursive() {
|
||||
return (sf::GetFsInlineContext(os::GetCurrentThread()) & TlsIoRecursiveCallMask) != 0;
|
||||
}
|
||||
|
||||
inline TlsIoValueForInheritance GetTlsIoValueForInheritance() {
|
||||
return TlsIoValueForInheritance { sf::GetFsInlineContext(os::GetCurrentThread()) };
|
||||
}
|
||||
|
||||
inline void SetTlsIoValueForInheritance(TlsIoValueForInheritance tls_io) {
|
||||
sf::SetFsInlineContext(os::GetCurrentThread(), tls_io._tls_value);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
/*
|
||||
* Copyright (c) 2018-2020 Atmosphère-NX
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms and conditions of the GNU General Public License,
|
||||
* version 2, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope 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, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#pragma once
|
||||
#include <stratosphere/fs/fs_common.hpp>
|
||||
#include <stratosphere/fs/fs_priority.hpp>
|
||||
#include <stratosphere/fs/impl/fs_fs_inline_context_utils.hpp>
|
||||
|
||||
namespace ams::fs::impl {
|
||||
|
||||
enum TlsIoPriority : u8 {
|
||||
TlsIoPriority_Normal = 0,
|
||||
TlsIoPriority_Realtime = 1,
|
||||
TlsIoPriority_Low = 2,
|
||||
TlsIoPriority_Background = 3,
|
||||
};
|
||||
|
||||
/* Ensure that TlsIo priority matches libnx priority. */
|
||||
static_assert(TlsIoPriority_Normal == static_cast<TlsIoPriority>(::FsPriority_Normal));
|
||||
static_assert(TlsIoPriority_Realtime == static_cast<TlsIoPriority>(::FsPriority_Realtime));
|
||||
static_assert(TlsIoPriority_Low == static_cast<TlsIoPriority>(::FsPriority_Low));
|
||||
static_assert(TlsIoPriority_Background == static_cast<TlsIoPriority>(::FsPriority_Background));
|
||||
|
||||
constexpr inline Result ConvertFsPriorityToTlsIoPriority(u8 *out, PriorityRaw priority) {
|
||||
AMS_ASSERT(out != nullptr);
|
||||
|
||||
switch (priority) {
|
||||
case PriorityRaw_Normal: *out = TlsIoPriority_Normal;
|
||||
case PriorityRaw_Realtime: *out = TlsIoPriority_Realtime;
|
||||
case PriorityRaw_Low: *out = TlsIoPriority_Low;
|
||||
case PriorityRaw_Background: *out = TlsIoPriority_Background;
|
||||
default: return fs::ResultInvalidArgument();
|
||||
}
|
||||
|
||||
return ResultSuccess();
|
||||
}
|
||||
|
||||
constexpr inline Result ConvertTlsIoPriorityToFsPriority(PriorityRaw *out, u8 tls_io) {
|
||||
AMS_ASSERT(out != nullptr);
|
||||
|
||||
switch (static_cast<TlsIoPriority>(tls_io)) {
|
||||
case TlsIoPriority_Normal: *out = PriorityRaw_Normal;
|
||||
case TlsIoPriority_Realtime: *out = PriorityRaw_Realtime;
|
||||
case TlsIoPriority_Low: *out = PriorityRaw_Low;
|
||||
case TlsIoPriority_Background: *out = PriorityRaw_Background;
|
||||
default: return fs::ResultInvalidArgument();
|
||||
}
|
||||
|
||||
return ResultSuccess();
|
||||
}
|
||||
|
||||
inline u8 GetTlsIoPriority(os::ThreadType *thread) {
|
||||
return sf::GetFsInlineContext(thread) & TlsIoPriorityMask;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
/*
|
||||
* Copyright (c) 2018-2020 Atmosphère-NX
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms and conditions of the GNU General Public License,
|
||||
* version 2, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope 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, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#pragma once
|
||||
#include <vapours.hpp>
|
||||
|
||||
namespace ams::fs::impl {
|
||||
|
||||
bool IsAbortNeeded(Result result);
|
||||
void LogErrorMessage(Result result, const char *function);
|
||||
|
||||
}
|
||||
|
||||
#define AMS_FS_R_CHECK_ABORT_IMPL(__RESULT__, __FORCE__) \
|
||||
({ \
|
||||
if (::ams::fs::impl::IsAbortNeeded(__RESULT__) || (__FORCE__)) { \
|
||||
::ams::fs::impl::LogErrorMessage(__RESULT__, AMS_CURRENT_FUNCTION_NAME); \
|
||||
R_ABORT_UNLESS(__RESULT__); \
|
||||
} \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_TRY(__RESULT__) \
|
||||
({ \
|
||||
const ::ams::Result __tmp_fs_result = (__RESULT__); \
|
||||
AMS_FS_R_CHECK_ABORT_IMPL(__tmp_fs_result, false); \
|
||||
R_TRY(__tmp_fs_result); \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_ABORT_UNLESS(__RESULT__) \
|
||||
({ \
|
||||
const ::ams::Result __tmp_fs_result = (__RESULT__); \
|
||||
AMS_FS_R_CHECK_ABORT_IMPL(__tmp_fs_result, true); \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_THROW(__RESULT__) \
|
||||
({ \
|
||||
const ::ams::Result __tmp_fs_result = (__RESULT__); \
|
||||
AMS_FS_R_CHECK_ABORT_IMPL(__tmp_fs_result, false); \
|
||||
return __tmp_fs_result; \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_UNLESS(__EXPR__, __RESULT__) \
|
||||
({ \
|
||||
if (!(__EXPR__)) { \
|
||||
AMS_FS_R_THROW((__RESULT__)); \
|
||||
} \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_TRY_CATCH(__EXPR__) R_TRY_CATCH(__EXPR__)
|
||||
|
||||
#define AMS_FS_R_CATCH(...) R_CATCH(__VA_ARGS__)
|
||||
|
||||
#define AMS_FS_R_END_TRY_CATCH \
|
||||
else if (R_FAILED(R_CURRENT_RESULT)) { \
|
||||
AMS_FS_R_THROW(R_CURRENT_RESULT); \
|
||||
} \
|
||||
} \
|
||||
})
|
||||
|
||||
#define AMS_FS_R_END_TRY_CATCH_WITH_ABORT_UNLESS \
|
||||
else { \
|
||||
AMS_FS_R_ABORT_UNLESS(R_CURRENT_RESULT); \
|
||||
} \
|
||||
} \
|
||||
})
|
||||
Loading…
Add table
Add a link
Reference in a new issue