#include #include "loader/component_loader.hpp" #include "game/game.hpp" #include "game/dvars.hpp" #include "component/filesystem.hpp" #include "component/console.hpp" #include "component/scripting.hpp" #include "component/fastfiles.hpp" #include "script_loading.hpp" #include #include #include #include namespace gsc { std::unique_ptr gsc_ctx; game::dvar_t* developer_script = nullptr; namespace { std::unordered_map main_handles; std::unordered_map init_handles; std::unordered_map loaded_scripts; utils::memory::allocator script_allocator; struct { char* buf = nullptr; char* pos = nullptr; unsigned int size = 0x1000000; } script_memory; char* allocate_buffer(size_t size) { if (script_memory.buf == nullptr) { script_memory.buf = game::PMem_AllocFromSource_NoDebug(script_memory.size, 4, 1, game::PMEM_SOURCE_SCRIPT); script_memory.pos = script_memory.buf; } if (script_memory.pos + size > script_memory.buf + script_memory.size) { game::Com_Error(game::ERR_FATAL, "Out of custom script memory"); } const auto pos = script_memory.pos; script_memory.pos += size; return pos; } void free_script_memory() { game::PMem_PopFromSource_NoDebug(script_memory.buf, script_memory.size, 4, 1, game::PMEM_SOURCE_SCRIPT); script_memory.buf = nullptr; script_memory.pos = nullptr; } void clear() { main_handles.clear(); init_handles.clear(); loaded_scripts.clear(); script_allocator.clear(); free_script_memory(); } bool read_raw_script_file(const std::string& name, std::string* data) { if (filesystem::read_file(name, data)) { return true; } const auto name_str = name.data(); if (game::DB_XAssetExists(game::ASSET_TYPE_RAWFILE, name_str) && !game::DB_IsXAssetDefault(game::ASSET_TYPE_RAWFILE, name_str)) { const auto asset = game::DB_FindXAssetHeader(game::ASSET_TYPE_RAWFILE, name.data(), false); const auto len = game::DB_GetRawFileLen(asset.rawfile); data->resize(len); game::DB_GetRawBuffer(asset.rawfile, data->data(), len); if (len > 0) { data->pop_back(); } return true; } return false; } game::ScriptFile* load_custom_script(const char* file_name, const std::string& real_name) { if (const auto itr = loaded_scripts.find(real_name); itr != loaded_scripts.end()) { return itr->second; } try { auto& compiler = gsc_ctx->compiler(); auto& assembler = gsc_ctx->assembler(); std::string source_buffer{}; if (!read_raw_script_file(real_name + ".gsc", &source_buffer)) { return nullptr; } std::vector data; data.assign(source_buffer.begin(), source_buffer.end()); const auto assembly_ptr = compiler.compile(real_name, data); const auto output_script = assembler.assemble(*assembly_ptr); const auto script_file_ptr = static_cast(script_allocator.allocate(sizeof(game::ScriptFile))); script_file_ptr->name = file_name; script_file_ptr->len = static_cast(output_script.second.size); script_file_ptr->bytecodeLen = static_cast(output_script.first.size); const auto stack_size = static_cast(output_script.second.size + 1); const auto byte_code_size = static_cast(output_script.first.size + 1); script_file_ptr->buffer = static_cast(script_allocator.allocate(stack_size)); std::memcpy(const_cast(script_file_ptr->buffer), output_script.second.data, output_script.second.size); script_file_ptr->bytecode = allocate_buffer(byte_code_size); std::memcpy(script_file_ptr->bytecode, output_script.first.data, output_script.first.size); script_file_ptr->compressedLen = 0; loaded_scripts[real_name] = script_file_ptr; return script_file_ptr; } catch (const std::exception& ex) { console::error("*********** script compile error *************\n"); console::error("failed to compile '%s':\n%s", real_name.data(), ex.what()); console::error("**********************************************\n"); return nullptr; } } std::string get_raw_script_file_name(const std::string& name) { if (name.ends_with(".gsh")) { return name; } return name + ".gsc"; } std::string get_script_file_name(const std::string& name) { const auto id = gsc_ctx->token_id(name); if (!id) { return name; } return std::to_string(id); } auto read_compiled_script_file(const std::string& name, const std::string& real_name) { const auto* script_file = game::DB_FindXAssetHeader(game::ASSET_TYPE_SCRIPTFILE, name.data(), false).scriptfile; if (!script_file) { throw std::runtime_error(std::format("Could not load scriptfile '{}'", real_name)); } const auto len = script_file->compressedLen; const std::string stack{script_file->buffer, static_cast(len)}; const auto decompressed_stack = utils::compression::zlib::decompress(stack); std::vector stack_data; stack_data.assign(decompressed_stack.begin(), decompressed_stack.end()); const xsk::gsc::buffer buffer{reinterpret_cast(script_file->bytecode), static_cast(script_file->bytecodeLen)}; return std::make_pair(buffer, stack_data); } void load_script(const std::string& name) { if (!game::Scr_LoadScript(name.data())) { return; } const auto main_handle = game::Scr_GetFunctionHandle(name.data(), gsc_ctx->token_id("main")); const auto init_handle = game::Scr_GetFunctionHandle(name.data(), gsc_ctx->token_id("init")); if (main_handle) { console::info("Loaded '%s::main'\n", name.data()); main_handles[name] = main_handle; } if (init_handle) { console::info("Loaded '%s::init'\n", name.data()); init_handles[name] = init_handle; } } void load_scripts(const std::filesystem::path& root_dir, const std::string& subfolder) { std::filesystem::path script_dir = root_dir / subfolder; if (!utils::io::directory_exists(script_dir.generic_string())) { return; } const auto scripts = utils::io::list_files(script_dir.generic_string()); for (const auto& script : scripts) { if (!script.ends_with(".gsc")) { continue; } std::filesystem::path path(script); const auto relative = path.lexically_relative(root_dir).generic_string(); const auto base_name = relative.substr(0, relative.size() - 4); load_script(base_name); } } int db_is_x_asset_default(game::XAssetType type, const char* name) { if (loaded_scripts.contains(name)) { return 0; } return game::DB_IsXAssetDefault(type, name); } void load_gametype_script_stub(void* a1, void* a2) { utils::hook::invoke(0x1404E1400, a1, a2); fastfiles::enum_assets(game::ASSET_TYPE_RAWFILE, [](game::XAssetHeader header) { std::string name = header.rawfile->name; if (name.ends_with(".gsc") && name.starts_with("scripts/")) { const auto base_name = name.substr(0, name.size() - 4); load_script(base_name); } }, true); const auto mapname = game::Dvar_FindVar("mapname"); for (const auto& path : filesystem::get_search_paths()) { load_scripts(path, "scripts"); load_scripts(path, "scripts/"s + mapname->current.string); } } void db_get_raw_buffer_stub(const game::RawFile* rawfile, char* buf, const int size) { if (rawfile->len > 0 && rawfile->compressedLen == 0) { std::memset(buf, 0, size); std::memcpy(buf, rawfile->buffer, std::min(rawfile->len, size)); return; } game::DB_GetRawBuffer(rawfile, buf, size); } void g_load_structs_stub() { for (auto& function_handle : main_handles) { console::info("Executing '%s::main'\n", function_handle.first.data()); const auto thread = game::Scr_ExecThread(function_handle.second, 0); game::RemoveRefToObject(thread); } utils::hook::invoke(0x140510B40); } void scr_load_level_stub() { utils::hook::invoke(0x1404FD130); for (auto& function_handle : init_handles) { console::info("Executing '%s::init'\n", function_handle.first.data()); const auto thread = game::Scr_ExecThread(function_handle.second, 0); game::RemoveRefToObject(thread); } } void scr_begin_load_scripts_stub() { const auto comp_mode = developer_script->current.enabled ? xsk::gsc::build::dev : xsk::gsc::build::prod; gsc_ctx->init(comp_mode, [](const std::string& include_name) -> std::pair> { const auto real_name = get_raw_script_file_name(include_name); std::string file_buffer; if (!read_raw_script_file(real_name, &file_buffer) || file_buffer.empty()) { const auto name = get_script_file_name(include_name); if (game::DB_XAssetExists(game::ASSET_TYPE_SCRIPTFILE, name.data())) { return read_compiled_script_file(name, real_name); } throw std::runtime_error(std::format("Could not load gsc file '{}'", real_name)); } std::vector script_data; script_data.assign(file_buffer.begin(), file_buffer.end()); return {{}, script_data}; }); utils::hook::invoke(0x1405BCAE0); } void sl_end_load_scripts_stub() { gsc_ctx->cleanup(); utils::hook::invoke(0x1405BFBF0); } void pmem_init_stub() { utils::hook::invoke(0x14061EC80); const auto type_0 = &game::g_scriptmem[0]; const auto type_1 = &game::g_scriptmem[1]; const auto size_0 = 0x200000; // default size const auto size_1 = 0x200000 + script_memory.size; const auto block = reinterpret_cast(VirtualAlloc(NULL, size_0 + size_1, MEM_RESERVE, PAGE_READWRITE)); type_0->buf = block; type_0->size = size_0; type_1->buf = block + size_0; type_1->size = size_1; utils::hook::set(0x14061EC72, size_0 + size_1); } } game::ScriptFile* find_script(game::XAssetType type, const char* name, int allow_create_default) { std::string real_name = name; const auto id = static_cast(std::strtol(name, nullptr, 10)); if (id) { real_name = gsc_ctx->token_name(id); } auto* script = load_custom_script(name, real_name); if (script) { return script; } return game::DB_FindXAssetHeader(type, name, allow_create_default).scriptfile; } class loading final : public component_interface { public: void post_load() override { gsc_ctx = std::make_unique(); } void post_unpack() override { utils::hook::call(0x1404E1627, scr_begin_load_scripts_stub); utils::hook::call(0x1405BCC14, sl_end_load_scripts_stub); developer_script = dvars::register_bool("developer_script", false, game::DVAR_FLAG_NONE, "Enable developer script comments"); utils::hook::call(0x1405C6177, find_script); utils::hook::call(0x1405C6187, db_is_x_asset_default); // Loads scripts with an uncompressed stack utils::hook::call(0x1405C61E0, db_get_raw_buffer_stub); // load handles utils::hook::call(0x1404E17B2, load_gametype_script_stub); // execute handles utils::hook::call(0x1404C8F71, g_load_structs_stub); utils::hook::call(0x1404C8F80, scr_load_level_stub); // increase script memory utils::hook::call(0x1405A4798, pmem_init_stub); scripting::on_shutdown([](bool free_scripts, bool post_shutdown) { if (free_scripts && post_shutdown) { clear(); } }); } }; } REGISTER_COMPONENT(gsc::loading)