Salastil/SmokeAPI
1
0
Fork 0
mirror of https://github.com/acidicoala/SmokeAPI.git synced 2025-12-05 21:15:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

Reworked tools

Browse Source
This commit is contained in:
acidicoala
2025-08-18 05:23:13 +05:00
parent 5f1e83adad
commit b170fd2276
23 changed files with 5826 additions and 3510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.clang-format
View File

@@ -13,4 +13,10 @@ UseTab: Never
PointerAlignment: Left
SortIncludes: true
AllowShortFunctionsOnASingleLine: Empty
FixNamespaceComments: false
FixNamespaceComments: false
ExperimentalAutoDetectBinPacking: false
BinPackParameters: OnePerLine
AllowAllParametersOfDeclarationOnNextLine: true
BinPackArguments: false
AllowAllArgumentsOnNextLine: true

4
.clang-tidy
View File

@@ -1,4 +1,3 @@
# Generated from CLion Inspection settings
---
Checks: '-*,
cppcoreguidelines-interfaces-global-init,
@@ -69,4 +68,5 @@ misc-*,
-readability-identifier-length,
-readability-named-parameter,
-readability-function-cognitive-complexity,
-misc-include-cleaner'
-*-include-cleaner,
-*-lambda-function-name'

1
.idea/dictionaries/project.xml generated
View File

@@ -2,6 +2,7 @@
<dictionary name="project">
<words>
<w>abcdefghijklmnopqrstuvwxyz</w>
<w>indicies</w>
<w>koalabox</w>
<w>koaloader</w>
</words>

7
.idea/runConfigurations/SmokeAPI.xml generated
View File

@@ -1,7 +0,0 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="SmokeAPI" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="SmokeAPI" CONFIG_NAME="Debug [64]">
<method v="2">
<option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
</method>
</configuration>
</component>

7
.idea/runConfigurations/exports_generator__64_.xml generated Normal file
View File

@@ -0,0 +1,7 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="exports_generator [64]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="FALSE steam_api64_o $ProjectFileDir$/res/steamworks/*/binaries/steam_api64.dll $ProjectFileDir$/build/64/linker_exports.h $ProjectFileDir$/src/game_mode/exports" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="exports_generator" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="exports_generator">
<method v="2">
<option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
</method>
</configuration>
</component>

2
.idea/runConfigurations/steamworks_downloader__prompt_.xml generated
View File

@@ -1,5 +1,5 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="steamworks_downloader [prompt]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="$Prompt$" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_downloader" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_downloader">
<configuration default="false" name="steamworks_downloader [prompt]" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="$Prompt$" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_downloader" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_downloader">
<method v="2">
<option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
</method>

2
.idea/runConfigurations/steamworks_parser.xml generated
View File

@@ -1,5 +1,5 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="steamworks_parser" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res/" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_parser" CONFIG_NAME="Debug [64]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_parser">
<configuration default="false" name="steamworks_parser" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" WORKING_DIR="file://$ProjectFileDir$/res/" PASS_PARENT_ENVS_2="true" PROJECT_NAME="SmokeAPI" TARGET_NAME="steamworks_parser" CONFIG_NAME="Debug [32]" RUN_TARGET_PROJECT_NAME="SmokeAPI" RUN_TARGET_NAME="steamworks_parser">
<method v="2">
<option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
</method>

2
CMakeLists.txt
View File

@@ -24,7 +24,6 @@ set(
src/game_mode/exports/steam_api_unversioned.cpp
)
configure_build_config(extra_build_config)
set(
@@ -70,6 +69,7 @@ set(
# Include store_mode mode sources only in 32-bit builds
if (CMAKE_SIZEOF_VOID_P EQUAL 4)
# TODO: Use list(APPEND ...) ?
set(
SMOKE_API_SOURCES ${SMOKE_API_SOURCES}
src/store_mode/steamclient/client_app_manager.cpp

2
KoalaBox

Submodule KoalaBox updated: f08d46d4c4...afb09983ca

5
docs/building_from_source.md
View File

@@ -1,2 +1,3 @@
- Rework Koalabox integration: Remove submodule, add conditional include (local filesystem and CPM)
- Write up documentation
# Building from source
TODO

1
docs/steamworks_support.md
View File

@@ -1 +0,0 @@
#

3
docs/tools.md
View File

@@ -0,0 +1,3 @@
# Tools
TODO: describe steamworks_downloader and steamworks_parser tools

8956
res/interface_lookup.json
View File

File diff suppressed because it is too large Load Diff

35
src/core/types.hpp
View File

@@ -1,10 +1,10 @@
#pragma once
#include <nlohmann/json.hpp>
#include <core/globals.hpp>
#include <koalabox/core.hpp>
#include <koalabox/hook.hpp>
#include <koalabox/logger.hpp>
#include <nlohmann/json.hpp>
/**
* By default, virtual functions are declared with __thiscall
@@ -30,35 +30,39 @@
* The macros below implement the above-mentioned considerations.
*/
#ifdef _WIN64
#define PARAMS(...) void* RCX, __VA_ARGS__
#define PARAMS(...) void *RCX, __VA_ARGS__
#define ARGS(...) RCX, __VA_ARGS__
#define THIS RCX
#else
#define PARAMS(...) const void* ECX, const void* EDX, __VA_ARGS__
#define PARAMS(...) const void *ECX, const void *EDX, __VA_ARGS__
#define ARGS(...) ECX, EDX, __VA_ARGS__
#define THIS ECX
#endif
// Names beginning with $ designate macros that are not meant to be used directly by the sources consuming this file
// Names beginning with $ designate macros that are not meant to be used directly by the sources
// consuming this file
// IMPORTANT: DLL_EXPORT is hardcoded in exports_generator.cpp,
// so any name changes here must be reflected there as well.
#define DLL_EXPORT(TYPE) extern "C" [[maybe_unused]] __declspec(dllexport) TYPE __cdecl
#define DLL_EXPORT(TYPE) extern "C" [[maybe_unused]] __declspec( dllexport ) TYPE __cdecl
#define VIRTUAL(TYPE) __declspec(noinline) TYPE __fastcall
// TODO: Replace with direct call
#define GET_ORIGINAL_HOOKED_FUNCTION(FUNC) \
#define GET_ORIGINAL_HOOKED_FUNCTION(FUNC) \
static const auto FUNC##_o = koalabox::hook::get_original_hooked_function(#FUNC, FUNC);
#define ORIGINAL_FUNCTION_STEAMAPI(FUNC) \
#define ORIGINAL_FUNCTION_STEAMAPI(FUNC) \
koalabox::hook::get_original_function(globals::steamapi_module, #FUNC, FUNC)
// TODO: Rename to DEFINE_ORIGINAL_FUNCTION_STEAMAPI
#define GET_ORIGINAL_FUNCTION_STEAMAPI(FUNC) \
#define GET_ORIGINAL_FUNCTION_STEAMAPI(FUNC) \
static const auto FUNC##_o = ORIGINAL_FUNCTION_STEAMAPI(FUNC);
#define DETOUR_ADDRESS(FUNC, ADDRESS) \
#define DETOUR_ADDRESS(FUNC, ADDRESS) \
koalabox::hook::detour_or_warn(ADDRESS, #FUNC, reinterpret_cast<uintptr_t>(FUNC));
#define $DETOUR(FUNC, NAME, MODULE_HANDLE) \
#define $DETOUR(FUNC, NAME, MODULE_HANDLE) \
koalabox::hook::detour_or_warn(MODULE_HANDLE, NAME, reinterpret_cast<uintptr_t>(FUNC));
#define DETOUR_STEAMCLIENT(FUNC) $DETOUR(FUNC, #FUNC, globals::steamclient_module)
@@ -116,16 +120,15 @@ struct App {
using AppDlcNameMap = Map<AppIdKey, App>;
class DLC {
private:
private:
// These 2 names must match the property names from Steam API
String appid;
String name;
public:
public:
explicit DLC() = default;
explicit DLC(String appid, String name) : appid{std::move(appid)}, name{std::move(name)} {
}
explicit DLC(String appid, String name) : appid{std::move(appid)}, name{std::move(name)} {}
[[nodiscard]] String get_id_str() const {
return appid;
@@ -141,7 +144,7 @@ public:
NLOHMANN_DEFINE_TYPE_INTRUSIVE(DLC, appid, name)
static Vector<DLC> get_dlcs_from_apps(const AppDlcNameMap &apps, AppId_t app_id);
static Vector<DLC> get_dlcs_from_apps(const AppDlcNameMap& apps, AppId_t app_id);
static DlcNameMap get_dlc_map_from_vector(const Vector<DLC> &vector);
static DlcNameMap get_dlc_map_from_vector(const Vector<DLC>& vector);
};

13
src/game_mode/exports/steam_api.cpp
View File

@@ -1,5 +1,18 @@
#include <smoke_api/config.hpp>
// DLL_EXPORT(void) SteamAPI_Shutdown1() {
// LOG_INFO("{} -> Game requested shutdown", __func__);
//
// ORIGINAL_FUNCTION_STEAMAPI(SteamAPI_Shutdown)();
// }
/*DLL_EXPORT(void) SteamAPI_Shutdown2() {
LOG_INFO("{} -> Game requested shutdown", __func__);
ORIGINAL_FUNCTION_STEAMAPI(SteamAPI_Shutdown)();
}*/
// TODO: Detour in hook mode
DLL_EXPORT(bool) SteamAPI_RestartAppIfNecessary(
[[maybe_unused]] const uint32_t unOwnAppID

8
src/smoke_api/smoke_api.cpp
View File

@@ -5,6 +5,7 @@
#include <koalabox/hook.hpp>
#include <koalabox/loader.hpp>
#include <koalabox/logger.hpp>
#include <koalabox/str.hpp>
#include <koalabox/util.hpp>
#include <koalabox/win_util.hpp>
@@ -40,8 +41,9 @@
namespace {
void override_app_id() {
const auto override_app_id = smoke_api::config::instance.override_app_id;
if (override_app_id == 0)
if (override_app_id == 0) {
return;
}
spdlog::default_logger_raw();
LOG_DEBUG("Overriding app id to {}", override_app_id);
@@ -74,7 +76,7 @@ namespace {
bool is_valve_steam(const String& exe_name) noexcept {
try {
if (exe_name < not_equals > "steam.exe") {
if (not koalabox::str::eq(exe_name, "steam.exe")) {
return false;
}
@@ -85,7 +87,7 @@ namespace {
const auto manifest = koalabox::win_util::get_module_manifest(steam_handle);
// Steam.exe manifest is expected to contain this string
return manifest < contains > "valvesoftware.steam.steam";
return manifest.contains("valvesoftware.steam.steam");
} catch (const Exception& e) {
LOG_ERROR("{} -> {}", __func__, e.what());

4
src/store_mode/steamclient/client_app_manager.cpp
View File

@@ -4,14 +4,14 @@
VIRTUAL(bool) IClientAppManager_IsAppDlcInstalled(PARAMS(AppId_t app_id, AppId_t dlc_id)) {
try {
return steam_apps::IsDlcUnlocked(
__func__, app_id, dlc_id, [&]() {
__func__, app_id, dlc_id, [&] {
GET_ORIGINAL_HOOKED_FUNCTION(IClientAppManager_IsAppDlcInstalled)
return IClientAppManager_IsAppDlcInstalled_o(ARGS(app_id, dlc_id));
}
);
} catch (const Exception& e) {
LOG_ERROR("{} -> Error: {}", __func__, e.what())
LOG_ERROR("{} -> Error: {}", __func__, e.what());
return false;
}
}

6
src/store_mode/steamclient/client_apps.cpp
View File

@@ -11,7 +11,7 @@ VIRTUAL(int) IClientApps_GetDLCCount(PARAMS(AppId_t appId)) {
}
);
} catch (const Exception& e) {
LOG_ERROR("{} -> Error: {}", __func__, e.what())
LOG_ERROR("{} -> Error: {}", __func__, e.what());
return 0;
}
}
@@ -36,7 +36,7 @@ VIRTUAL(bool) IClientApps_BGetDLCDataByIndex(
ARGS(appID, iDLC, pDlcID, pbAvailable, pchName, cchNameBufferSize)
);
},
[&](AppId_t dlc_id) {
[&](const AppId_t dlc_id) {
const auto* app_manager_interface = store::steamclient::interface_name_to_address_map["IClientAppManager"];
if (app_manager_interface) {
IClientAppManager_IsAppDlcInstalled(app_manager_interface, EDX, appID, dlc_id);
@@ -48,7 +48,7 @@ VIRTUAL(bool) IClientApps_BGetDLCDataByIndex(
}
);
} catch (const Exception& e) {
LOG_ERROR("{} -> Error: {}", __func__, e.what())
LOG_ERROR("{} -> Error: {}", __func__, e.what());
return false;
}
}

26
src/store_mode/steamclient/steamclient.cpp
View File

@@ -91,7 +91,7 @@ namespace store::steamclient {
}
void detour_interface_selector(const String& interface_name, uintptr_t function_selector_address) {
LOG_DEBUG("Detected interface: '{}'", interface_name)
LOG_DEBUG("Detected interface: '{}'", interface_name);
DETOUR_SELECTOR(IClientAppManager)
DETOUR_SELECTOR(IClientApps)
@@ -198,10 +198,10 @@ namespace store::steamclient {
const std::list<ZydisDecodedInstruction>& instruction_list
)>& callback
) {
LOG_TRACE("{} -> start_address: {}", __func__, (void*) start_address)
LOG_TRACE("{} -> start_address: {}", __func__, (void*) start_address);
if (visited_addresses.contains(start_address)) {
LOG_TRACE("Breaking recursion due to visited address")
LOG_TRACE("Breaking recursion due to visited address");
return;
}
@@ -222,7 +222,7 @@ namespace store::steamclient {
LOG_TRACE(
"{} -> visiting {} │ {}",
__func__, (void*) current_address, *get_instruction_string(instruction, current_address)
)
);
const auto operand = instruction.operands[0];
@@ -239,7 +239,7 @@ namespace store::steamclient {
visit_code(visited_addresses, jump_taken_destination, context, callback);
visit_code(visited_addresses, jump_not_taken_destination, context, callback);
LOG_TRACE("{} -> Breaking recursion due to a conditional branch", __func__)
LOG_TRACE("{} -> Breaking recursion due to a conditional branch", __func__);
return;
}
@@ -266,12 +266,12 @@ namespace store::steamclient {
table_entry++;
}
LOG_TRACE("{} -> Breaking recursion due to a jump table", __func__)
LOG_TRACE("{} -> Breaking recursion due to a jump table", __func__);
return;
}
if (instruction.mnemonic == ZYDIS_MNEMONIC_RET) {
LOG_TRACE("{} -> Breaking recursion due to return instruction", __func__)
LOG_TRACE("{} -> Breaking recursion due to return instruction", __func__);
return;
}
@@ -385,7 +385,7 @@ namespace store::steamclient {
if (offset && is_derived_from_base_reg) {
const auto ordinal = *offset / sizeof(uintptr_t);
LOG_DEBUG("Found function ordinal {}::{}@{}", target_interface, function_name, ordinal)
LOG_DEBUG("Found function ordinal {}::{}@{}", target_interface, function_name, ordinal);
function_name_to_ordinal_map[function_name] = ordinal;
return true;
@@ -410,7 +410,7 @@ namespace store::steamclient {
const auto&
) {
if (instruction.mnemonic == ZYDIS_MNEMONIC_CALL && operand.type == ZYDIS_OPERAND_TYPE_IMMEDIATE) {
LOG_TRACE("Found call instruction at {}", (void*) current_address)
LOG_TRACE("Found call instruction at {}", (void*) current_address);
const auto function_selector_address = get_absolute_address(instruction, current_address);
@@ -436,15 +436,15 @@ namespace store::steamclient {
store::config.steam_client_internal_interface_selector_ordinal
];
LOG_DEBUG("Found interface selector at: {}", (void*) interface_selector_address)
LOG_DEBUG("Found interface selector at: {}", (void*) interface_selector_address);
if (ZYAN_FAILED(ZydisDecoderInit(&decoder, ZYDIS_MACHINE_MODE_LEGACY_32, ZYDIS_ADDRESS_WIDTH_32))) {
LOG_ERROR("Failed to initialize zydis decoder")
if (ZYAN_FAILED(ZydisDecoderInit(&decoder, ZYDIS_MACHINE_MODE_LEGACY_32, ZYDIS_STACK_WIDTH_32))) {
LOG_ERROR("Failed to initialize zydis decoder");
return;
}
if (ZYAN_FAILED(ZydisFormatterInit(&formatter, ZYDIS_FORMATTER_STYLE_INTEL))) {
LOG_ERROR("Failed to initialize zydis formatter")
LOG_ERROR("Failed to initialize zydis formatter");
return;
}

34
src/store_mode/store.cpp
View File

@@ -1,13 +1,15 @@
#include <store_mode/store.hpp>
#include <store_mode/vstdlib/vstdlib.hpp>
#include <store_mode/store_cache.hpp>
#include <store_mode/store_api.hpp>
#include <smoke_api/config.hpp>
#include "koalabox/str.hpp"
#include <build_config.h>
#include <koalabox/dll_monitor.hpp>
#include <koalabox/logger.hpp>
#include <koalabox/ipc.hpp>
#include <common/steamclient_exports.hpp>
#include <koalabox/dll_monitor.hpp>
#include <koalabox/ipc.hpp>
#include <koalabox/logger.hpp>
#include <smoke_api/config.hpp>
#include <store_mode/store.hpp>
#include <store_mode/store_api.hpp>
#include <store_mode/store_cache.hpp>
#include <store_mode/vstdlib/vstdlib.hpp>
namespace store {
@@ -18,7 +20,7 @@ namespace store {
*/
void init_store_config() {
const auto print_source = [](const String& source) {
LOG_INFO("Loaded Store config from the {}", source)
LOG_INFO("Loaded Store config from the {}", source);
};
// First try to read a local config override
@@ -30,7 +32,7 @@ namespace store {
print_source("local config override");
return;
} catch (const Exception& ex) {
LOG_ERROR("Failed to get local store_mode config: {}", ex.what())
LOG_ERROR("Failed to get local store_mode config: {}", ex.what());
}
}
@@ -40,7 +42,7 @@ namespace store {
print_source("disk cache");
} catch (const Exception& ex) {
LOG_ERROR("Failed to get cached store_mode config: {}", ex.what())
LOG_ERROR("Failed to get cached store_mode config: {}", ex.what());
print_source("default config bundled in the binary");
@@ -62,7 +64,7 @@ namespace store {
store_cache::save_store_config(github_config);
if (github_config == config) {
LOG_DEBUG("Fetched Store config is equal to existing config")
LOG_DEBUG("Fetched Store config is equal to existing config");
return;
}
@@ -79,7 +81,7 @@ namespace store {
MB_SETFOREGROUND | MB_ICONINFORMATION | MB_OK
);
} catch (const Exception& ex) {
LOG_ERROR("Failed to get remote store_mode config: {}", ex.what())
LOG_ERROR("Failed to get remote store_mode config: {}", ex.what());
}
})
}
@@ -90,7 +92,7 @@ namespace store {
koalabox::dll_monitor::init_listener(
{VSTDLIB_DLL, STEAMCLIENT_DLL}, [](const HMODULE& module_handle, const String& name) {
try {
if (name < equals > VSTDLIB_DLL) {
if (koalabox::str::eq(name, VSTDLIB_DLL)) {
// VStdLib DLL handles Family Sharing functions
globals::vstdlib_module = module_handle;
@@ -98,7 +100,7 @@ namespace store {
if (smoke_api::config::instance.unlock_family_sharing) {
DETOUR_VSTDLIB(Coroutine_Create)
}
} else if (name < equals > STEAMCLIENT_DLL) {
} else if (koalabox::str::eq(name, STEAMCLIENT_DLL)) {
// SteamClient DLL handles unlocking functions
globals::steamclient_module = module_handle;
@@ -113,7 +115,7 @@ namespace store {
LOG_ERROR(
"Error listening to DLL load events. Module: '{}', Message: {}",
name, ex.what()
)
);
}
}
);

35
tools/CMakeLists.txt
View File

@@ -2,10 +2,6 @@ cmake_minimum_required(VERSION 3.24)
project(smoke-api-tools LANGUAGES CXX)
### Install CPM package manager
#include(../KoalaBox/cmake/get_cpm.cmake)
### Install parser library
CPMAddPackage(
@@ -24,11 +20,11 @@ add_grammar_from_repo(tree-sitter-cpp # Library name
### Install JSON library
CPMAddPackage(
NAME nlohmann_json
GIT_REPOSITORY https://github.com/nlohmann/json.git
GIT_TAG v3.12.0
)
#CPMAddPackage(
# NAME nlohmann_json
# GIT_REPOSITORY https://github.com/nlohmann/json.git
# GIT_TAG v3.12.0
#)
### Install HTTP client library
@@ -43,12 +39,15 @@ CPMAddPackage(
GIT_TAG 1.12.0
)
### Install ZIP library https://github.com/richgel999/miniz
CPMAddPackage(
NAME miniz
GIT_REPOSITORY https://github.com/richgel999/miniz.git
GIT_TAG c883286f1a6443720e7705450f59e579a4bbb8e2
NAME BS_thread_pool
GITHUB_REPOSITORY bshoshany/thread-pool
VERSION 5.0.0
EXCLUDE_FROM_ALL
SYSTEM
)
add_library(BS_thread_pool INTERFACE)
target_include_directories(BS_thread_pool INTERFACE ${BS_thread_pool_SOURCE_DIR}/include)
### Steamworks Downloader executable
@@ -56,14 +55,16 @@ add_executable(steamworks_downloader steamworks_downloader.cpp)
target_link_libraries(steamworks_downloader PRIVATE
KoalaBox
cpr # HTTP client
miniz # ZIP library
miniz # ZIP library TODO: Use koalabox instead
)
### Steamworks Parser executable
add_executable(steamworks_parser steamworks_parser.cpp)
target_link_libraries(steamworks_parser PRIVATE
nlohmann_json # JSON parser
tree-sitter-cpp # C++ grammar
cpp-tree-sitter # C++ bindings for tree-sitter
KoalaBox
BS_thread_pool
# nlohmann_json # JSON parser
# tree-sitter-cpp # C++ grammar
# cpp-tree-sitter # C++ bindings for tree-sitter
)

9
tools/steamworks_downloader.cpp
View File

@@ -2,6 +2,7 @@
#include <iostream>
#include <random>
#include <string>
#include <ranges>
#include <cpr/cpr.h>
@@ -11,8 +12,7 @@ namespace {
namespace fs = std::filesystem;
namespace zip = koalabox::zip;
// ReSharper disable once CppDFAConstantParameter
std::string generate_random_string(const size_t length) {
std::string generate_random_string() {
static constexpr char charset[] = "0123456789"
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"abcdefghijklmnopqrstuvwxyz";
@@ -20,6 +20,7 @@ namespace {
thread_local std::mt19937_64 rng{std::random_device{}()};
thread_local std::uniform_int_distribution<std::size_t> dist(0, sizeof(charset) - 2);
constexpr auto length = 16;
std::string result;
result.reserve(length);
for (std::size_t i = 0; i < length; ++i) {
@@ -59,7 +60,7 @@ namespace {
);
const auto zip_file_path =
fs::temp_directory_path() / (generate_random_string(16) + ".zip");
fs::temp_directory_path() / (generate_random_string() + ".zip");
std::cout << "Downloading " << download_url << " to " << zip_file_path << std::endl;
@@ -87,7 +88,7 @@ namespace {
* A tool for downloading Steamworks SDK and unpacking its headers and binaries
* for further processing by other tools.
*/
int main(const int argc, const char** argv) {
int main(const int argc, const char** argv) { // NOLINT(*-exception-escape)
if (argc == 1) {
print_help();
return 0;

166
tools/steamworks_parser.cpp
View File

@@ -1,31 +1,28 @@
#include <iostream>
#include <functional>
#include <filesystem>
#include "koalabox/crypto.hpp"
#include "koalabox/io.hpp"
#include "koalabox/util.hpp"
#include <chrono>
#include <deque>
#include <filesystem>
#include <fstream>
#include <functional>
#include <nlohmann/json.hpp>
#include <BS_thread_pool.hpp>
#include <cpp-tree-sitter.h>
#include <nlohmann/json.hpp>
extern "C" const TSLanguage* tree_sitter_cpp();
#include <koalabox/logger.hpp>
#include <koalabox/parser.hpp>
#include <koalabox/str.hpp>
namespace {
namespace fs = std::filesystem;
using json = nlohmann::json;
std::string_view trim(const std::string_view& s) {
const auto start =
std::ranges::find_if_not(s, [](const unsigned char ch) { return std::isspace(ch); });
const auto end =
std::find_if_not(
s.rbegin(), s.rend(),
[](const unsigned char ch) { return std::isspace(ch); }
).base();
return start < end ? std::string_view(start, end) : std::string_view();
}
namespace fs = std::filesystem;
namespace parser = koalabox::parser;
std::string_view unquote_if_quoted(const std::string_view& s) {
if (s.size() >= 2 && ((s.front() == '"' && s.back() == '"'))) {
if (s.size() >= 2 && s.front() == '"' && s.back() == '"') {
return s.substr(1, s.size() - 2);
}
@@ -33,145 +30,109 @@ namespace {
return s;
}
enum class VisitResult {
Continue,
SkipChildren,
Stop
};
void walk(
const ts::Node& root,
const std::function<VisitResult(ts::Node)>& visit
) {
// DFS traversal
std::deque<ts::Node> queue;
queue.push_back(root);
auto first_visit = true;
while (not queue.empty()) {
const auto node = queue.front();
queue.pop_front();
switch (first_visit ? VisitResult::Continue : visit(node)) {
case VisitResult::Continue:
break;
case VisitResult::SkipChildren:
continue;
case VisitResult::Stop:
return;
}
for (uint32_t i = 0, count = node.getNumNamedChildren(); i < count; ++i) {
if (const auto child = node.getNamedChild(i); not child.isNull()) {
queue.push_back(child);
}
}
first_visit = false;
}
}
void parse_header(const std::string_view& source, json& lookup) {
const auto language = ts::Language(tree_sitter_cpp());
auto parser = ts::Parser(language);
const auto tree = parser.parseString(source);
const auto tree = parser::parse_source(source);
const auto root = tree.getRootNode();
json current_lookup = {};
std::string interface_version;
walk(root, [&](const auto& current_node) {
parser::walk(root, [&](const auto& current_node) {
const auto current_type = current_node.getType();
if (current_type == "class_specifier") {
std::string interface_name;
[[maybe_unused]] int vt_idx = 0;
walk(current_node, [&](const ts::Node& class_node) {
koalabox::parser::walk(current_node, [&](const ts::Node& class_node) {
const auto type = class_node.getType();
const auto value = class_node.getSourceRange(source);
if (type == "type_identifier" && interface_name.empty()) {
interface_name = value;
std::cout << " Parsing interface: " << interface_name << std::endl;
LOG_DEBUG("Found interface: {}", interface_name);
return VisitResult::Continue;
return parser::visit_result::Continue;
}
if (type == "field_declaration" && value.starts_with("virtual ")) {
if (value.starts_with("virtual ")) {
walk(class_node, [&](const ts::Node& decl_node) {
koalabox::parser::walk(class_node, [&](const ts::Node& decl_node) {
if (decl_node.getType() == "field_identifier") {
const auto function_name =
decl_node.getSourceRange(source);
const auto function_name = decl_node.getSourceRange(source);
current_lookup[function_name]["vt_idx"] = vt_idx++;
return VisitResult::Stop;
current_lookup[function_name] = vt_idx++;
return parser::visit_result::Stop;
}
return VisitResult::Continue;
return parser::visit_result::Continue;
});
}
return VisitResult::SkipChildren;
return parser::visit_result::SkipChildren;
}
return VisitResult::Continue;
return parser::visit_result::Continue;
});
} else if (current_type == "preproc_def") {
walk(current_node, [&](const ts::Node& preproc_node) {
koalabox::parser::walk(current_node, [&](const ts::Node& preproc_node) {
if (preproc_node.getType() == "identifier") {
const auto identifier = preproc_node.getSourceRange(source);
return identifier.ends_with("INTERFACE_VERSION")
? VisitResult::Continue
: VisitResult::Stop;
? parser::visit_result::Continue
: parser::visit_result::Stop;
}
if (preproc_node.getType() == "preproc_arg") {
const auto quoted_version = preproc_node.getSourceRange(source);
interface_version = unquote_if_quoted(trim(quoted_version));
std::cout << " Interface version: " << interface_version << std::endl;
const auto trimmed_version = koalabox::str::trim(quoted_version);
interface_version = unquote_if_quoted(trimmed_version);
LOG_DEBUG("Interface version: {}", interface_version);
return VisitResult::Stop;
return parser::visit_result::Stop;
}
return VisitResult::Continue;
return parser::visit_result::Continue;
});
} else if (current_type == "translation_unit" || current_type == "preproc_ifdef") {
return VisitResult::Continue;
return parser::visit_result::Continue;
}
return VisitResult::SkipChildren;
return parser::visit_result::SkipChildren;
});
// Save the findings
static std::mutex mutex;
if (not interface_version.empty()) {
const std::lock_guard lock(mutex);
lookup[interface_version] = current_lookup;
}
}
void parse_sdk(const fs::path& sdk_path, json& lookup) {
void parse_sdk(const fs::path& sdk_path, json& lookup, BS::thread_pool<>& pool) {
const auto headers_dir = sdk_path / "headers";
if (not fs::exists(headers_dir)) {
std::cout << "Warning: SDK missing 'headers' directory: " << headers_dir << std::endl;
LOG_WARN("Warning: SDK missing 'headers' directory: {}", headers_dir.string());
return;
}
LOG_INFO("Parsing SDK: {}", headers_dir.string());
// Go over each file in headers directory
for (const auto& entry : fs::directory_iterator(headers_dir)) {
if (
const auto& header_path = entry.path();
header_path.extension() == ".h"
) {
std::cout << "Parsing header: " << header_path << std::endl;
if (const auto& header_path = entry.path(); header_path.extension() == ".h") {
const auto task = pool.submit_task([&, header_path] {
try {
LOG_DEBUG("Parsing header: {}", header_path.string());
// Read file as text
std::ifstream in(header_path, std::ios::binary);
const std::string header_contents(std::istreambuf_iterator{in}, {});
// Read file as text
const auto header_contents = koalabox::io::read_file(header_path);
// Parse it
parse_header(header_contents, lookup);
parse_header(header_contents, lookup);
} catch (std::exception& e) {
koalabox::util::panic(std::format("Error parsing header: {}", e.what()));
}
});
}
}
}
@@ -179,15 +140,23 @@ namespace {
void generate_lookup_json(const fs::path& steamworks_dir) {
json lookup;
// Create the thread pool
const auto thread_count = std::max(2U, std::thread::hardware_concurrency() / 2);
LOG_INFO("Creating task pool with {} threads", thread_count);
BS::thread_pool pool(thread_count);
// Go over each steamworks sdk version
for (const auto& entry : fs::directory_iterator(steamworks_dir)) {
if (not entry.is_directory()) {
continue;
}
parse_sdk(entry.path(), lookup);
parse_sdk(entry.path(), lookup, pool);
}
// Wait for all tasks to finish
pool.wait();
std::ofstream lookup_output("interface_lookup.json");
lookup_output << std::setw(4) << lookup << std::endl;
}
@@ -198,15 +167,22 @@ namespace {
*/
int main() {
try {
koalabox::logger::init_console_logger();
const auto steamworks_dir = fs::path("steamworks");
if (!fs::exists(steamworks_dir)) {
throw std::exception("Expected to find 'steamworks' in current working directory.");
}
const auto start = std::chrono::steady_clock::now();
generate_lookup_json(steamworks_dir);
const auto end = std::chrono::steady_clock::now();
const auto elapsed = duration_cast<std::chrono::seconds>(end - start);
LOG_INFO("Finished parsing steamworks in {} seconds", elapsed.count());
} catch (std::exception& e) {
std::cerr << "Error: " << e.what() << std::endl;
LOG_CRITICAL("Error: {}", e.what());
return 1;
}
}