Files
Cesarus85--ringfall-mjolnir-vr/source/cache/cache_files.c
T
Stefan MaierandClaude Opus 5.5 73e9bed243 VR test aid: both sticks held in spawn the map's next vehicle
debug.vehicle_spawn: holding both thumbsticks in for 1.5 s puts the next
vehicle the map has loaded (not the Pelican, dropship or lifepod) a few
metres ahead of the player, cycling through them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-30 15:55:25 +02:00

861 lines
20 KiB
C

/*
CACHE_FILES.C
symbols in this file:
001A9180 00f0:
_cache_files_map_directory (0000)
001A9270 0030:
_scenario_tags_unload (0000)
001A92A0 0010:
_tag_files_open (0000)
001A92B0 0010:
_tag_files_close (0000)
001A92C0 0040:
_tag_groups_checksum (0000)
001A9300 0010:
_cache_files_get_checksum (0000)
001A9310 00b0:
_tag_loaded (0000)
001A93C0 0020:
_cache_files_enable_writes (0000)
001A93E0 0090:
_cache_files_disable_writes (0000)
001A9470 0020:
_tag_block_resize (0000)
001A9490 0020:
_tag_data_resize (0000)
001A94B0 0020:
_tag_block_add_element (0000)
001A94D0 0010:
_tag_block_delete_element (0000)
001A94E0 0020:
_tag_load (0000)
001A9500 0010:
_tag_unload (0000)
001A9510 0020:
_tag_file_get_path (0000)
001A9530 0010:
_tag_reference_set (0000)
001A9540 0020:
_tag_iterator_new (0000)
001A9560 0070:
_tag_iterator_next (0000)
001A95D0 00f0:
_cache_get_tag_instance (0000)
001A96C0 0100:
_cache_file_header_verify (0000)
001A97C0 0090:
_cache_files_give_time_to_precache (0000)
001A9850 0130:
_scenario_tags_load (0000)
001A9980 0120:
_scenario_structure_bsp_load (0000)
001A9AA0 0080:
_scenario_structure_bsp_unload (0000)
001A9B20 00b0:
_tag_get (0000)
001A9BD0 0020:
_tag_get_name (0000)
001A9BF0 0020:
_tag_get_group_tag (0000)
002A62D8 0009:
??_C@_08NDLPNBDL@d?3?2maps?2?$AA@ (0000)
002A62E4 000c:
??_C@_0M@KPLLEAGM@d?3?2maps_it?2?$AA@ (0000)
002A62F0 000c:
??_C@_0M@OACCOJFB@d?3?2maps_es?2?$AA@ (0000)
002A62FC 000c:
??_C@_0M@PDFFCMII@d?3?2maps_fr?2?$AA@ (0000)
002A6308 000c:
??_C@_0M@EADFFBPG@d?3?2maps_de?2?$AA@ (0000)
002A6314 001e:
??_C@_0BO@JHMCCGLN@no?5valid?5map?5directory?5exists?$AA@ (0000)
002A6334 0023:
??_C@_0CD@DIDKODIK@c?3?2halo?2SOURCE?2cache?2cache_files@ (0000)
002A6358 001f:
??_C@_0BP@GJKOKCFG@cache_file_globals?4tags_loaded?$AA@ (0000)
002A6378 0015:
??_C@_0BF@KAIMLJJI@global_tag_instances?$AA@ (0000)
002A6390 003d:
??_C@_0DN@EPHHKDMF@tag_block_resize?$CI?$CJ?5is?5not?5suppor@ (0000)
002A63D0 003c:
??_C@_0DM@FNPDMPEA@tag_data_resize?$CI?$CJ?5is?5not?5support@ (0000)
002A6410 0042:
??_C@_0EC@MOKCAFPK@tag_block_add_element?$CI?$CJ?5is?5not?5s@ (0000)
002A6458 0045:
??_C@_0EF@NIGPCFB@tag_block_delete_element?$CI?$CJ?5is?5no@ (0000)
002A64A0 0035:
??_C@_0DF@IIJGOBIP@tag_load?$CI?$CJ?5is?5not?5supported?5with@ (0000)
002A64D8 0037:
??_C@_0DH@OJBEKPBJ@tag_unload?$CI?$CJ?5is?5not?5supported?5wi@ (0000)
002A6510 003e:
??_C@_0DO@CMGIBDCM@tag_file_get_path?$CI?$CJ?5is?5not?5suppo@ (0000)
002A6550 003e:
??_C@_0DO@PNBFAACM@tag_reference_set?$CI?$CJ?5is?5not?5suppo@ (0000)
002A6590 0022:
??_C@_0CC@JDEMIPEM@i?5don?8t?5think?5?$CF08x?5is?5a?5tag?5inde@ (0000)
002A65B4 0028:
??_C@_0CI@MCDCHEHF@?8?$CFs?8?5does?5not?5appear?5to?5be?5a?5cac@ (0000)
002A65DC 0036:
??_C@_0DG@MBMNLMG@the?5cache?5file?5?8?$CFs?8?5belongs?5to?5a@ (0000)
002A6614 0026:
??_C@_0CG@GAKJDLAF@the?5cache?5file?5?8?$CFs?8?5is?5an?5old?5ve@ (0000)
002A663C 002e:
??_C@_0CO@BLPPGPI@signature?5is?5?8?$CFc?$CFc?$CFc?$CFc?8?0?5should?5@ (0000)
002A666C 002b:
??_C@_0CL@BCHNHKGI@tag_instance?9?$DOgroup_tag?$DN?$DNSTRUCTU@ (0000)
002A6698 001c:
??_C@_0BM@EFCFDCHK@?$CBtag_instance?9?$DObase_address?$AA@ (0000)
002A66B8 005e:
??_C@_0FO@FEJCGGNA@cache_file_globals?4structure_bsp@ (0000)
002A6718 001b:
??_C@_0BL@OICFEJJN@tag_instance?9?$DObase_address?$AA@ (0000)
002A6734 0027:
??_C@_0CH@HHANGOKG@can?8t?5get?$CI?$CJ?5a?5tag?5with?5a?5base?5ad@ (0000)
002A675C 002e:
??_C@_0CO@IDEKIPEG@expected?5tag?5group?5?8?$CFs?8?5but?5got?5@ (0000)
00316820 0018:
_data_00316820 (0000)
004CCB20 080c:
_bss_004ccb20 (0000)
*/
/* ---------- headers */
#include "cseries.h"
#include "cseries_windows.h"
#include "errors.h"
#include "tag_files/tag_groups.h"
#include "tag_files/files.h"
#include "cache_files.h"
#include "physical_memory_map.h"
#include "sound_cache.h"
#include "scenario/scenario_definitions.h"
#include "sound/sound_manager.h"
/* ---------- constants */
/* ---------- macros */
#define STRUCTURE_BSP_TAG 'sbsp'
#define CACHE_FILE_TAG_HEADER_SIGNATURE 'tags'
#define CACHE_FILE_STRUCTURE_BSP_HEADER_SIGNATURE 'sbsp'
#define CACHE_FILE_HEADER_SIGNATURE 'head'
#define CACHE_FILE_FOOTER_SIGNATURE 'foot'
/* ---------- structures */
struct cache_file_tag_instance
{
long group_tag;
long parent_group_tags[2];
long tag_index;
char *name;
void *base_address;
unsigned long unused[2];
};
struct cache_file_tag_header
{
struct cache_file_tag_instance *tag_instances;
long scenario_tag_index;
unsigned long checksum;
long tag_count;
long vertex_buffer_count;
void *vertex_buffers;
long index_buffer_count;
void *index_buffers;
unsigned long signature;
};
struct cache_file_structure_bsp_header
{
void *base_address;
long vertex_buffer_count;
void *vertex_buffers;
long index_buffer_count;
void *index_buffers;
unsigned long signature;
};
struct cache_file_header
{
unsigned long header_signature;
long version;
long file_length;
byte reservedC[4];
long tag_data_offset;
long tag_data_size;
byte reserved18[8];
char name[0x20];
char build[0x20];
byte reserved60[4];
unsigned long checksum;
byte reserved68[0x794];
unsigned long footer_signature;
};
struct cache_file_globals
{
boolean tags_loaded;
byte pad1[3];
struct cache_file_header header;
struct cache_file_tag_header *tag_header;
struct cache_file_structure_bsp_header *structure_bsp_header;
};
typedef char verify_cache_file_tag_instance_size[
sizeof(struct cache_file_tag_instance) == 0x20 ? 1 : -1];
typedef char verify_cache_file_tag_header_count_offset[
offsetof(struct cache_file_tag_header, tag_count) == 0xC ? 1 : -1];
typedef char verify_cache_file_globals_size[
sizeof(struct cache_file_globals) == 0x80C ? 1 : -1];
typedef char verify_cache_file_header_size[
sizeof(struct cache_file_header) == 0x800 ? 1 : -1];
/* ---------- prototypes */
static struct cache_file_tag_instance *cache_get_tag_instance(
long tag_index);
void texture_cache_close(
void);
void display_error_damaged_media(
void);
void texture_cache_open(
void);
void sound_idle(
void);
/* ---------- globals */
struct cache_file_globals cache_file_globals = { 0 };
extern struct cache_file_tag_instance *global_tag_instances;
char const *data_00316820[] =
{
"d:\\maps_de\\",
"d:\\maps_fr\\",
"d:\\maps_es\\",
"d:\\maps_it\\",
"d:\\maps\\",
NULL
};
/* ---------- private code */
static struct cache_file_tag_instance *cache_get_tag_instance(
long tag_index)
{
short absolute_index;
struct cache_file_tag_instance *tag_instance;
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
518,
cache_file_globals.tags_loaded);
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
519,
global_tag_instances);
absolute_index = (short)tag_index;
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
522,
absolute_index >= 0 && absolute_index < cache_file_globals.tag_header->tag_count,
csprintf(temporary, "i don't think %08x is a tag index", tag_index));
tag_instance = &global_tag_instances[absolute_index];
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
526,
!(tag_index & 0xFFFF0000) || tag_instance->tag_index == tag_index,
csprintf(temporary, "i don't think %08x is a tag index", tag_index));
return tag_instance;
}
/* ---------- public code */
char const *cache_files_map_directory(
void)
{
char const *map_directory;
struct file_reference reference;
long directory_index;
switch (XGetLanguage())
{
case XC_LANGUAGE_GERMAN:
map_directory = "d:\\maps_de\\";
break;
case XC_LANGUAGE_FRENCH:
map_directory = "d:\\maps_fr\\";
break;
case XC_LANGUAGE_SPANISH:
map_directory = "d:\\maps_es\\";
break;
case XC_LANGUAGE_ITALIAN:
map_directory = "d:\\maps_it\\";
break;
default:
map_directory = "d:\\maps\\";
break;
}
if (!file_exists(file_reference_create_from_path(&reference, map_directory, TRUE)))
{
for (directory_index = 0; data_00316820[directory_index]; directory_index++)
{
if (file_exists(file_reference_create_from_path(
&reference,
data_00316820[directory_index],
TRUE)))
{
map_directory = data_00316820[directory_index];
break;
}
}
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
60,
data_00316820[directory_index],
"no valid map directory exists");
}
return map_directory;
}
void scenario_tags_unload(
void)
{
sound_cache_close();
texture_cache_close();
cache_file_close();
tags_header_deregister_vertex_and_index_buffers(cache_file_globals.tag_header);
cache_file_globals.tags_loaded = FALSE;
global_tag_instances = NULL;
return;
}
void tag_files_open(
void)
{
cache_files_initialize();
return;
}
void tag_files_close(
void)
{
cache_files_dispose();
return;
}
unsigned long cache_files_get_checksum(
void)
{
return cache_file_globals.header.checksum;
}
unsigned long tag_groups_checksum(
void)
{
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
327,
cache_file_globals.tags_loaded);
return cache_file_globals.tag_header->checksum;
}
#ifdef HALO_ANDROID
/* VR test aid: the loaded tag of the group after the given one (NONE: the
first), wrapping round; NONE if the map has none. Its name too. */
long tag_vr_next_loaded(
long group_tag,
long after_tag_index,
char const **name)
{
short absolute_index;
short start = 0;
short count;
if (!cache_file_globals.tags_loaded)
return NONE;
count = (short)cache_file_globals.tag_header->tag_count;
if (after_tag_index != NONE)
{
for (absolute_index = 0; absolute_index < count; absolute_index++)
{
if (global_tag_instances[absolute_index].tag_index == after_tag_index)
{
start = absolute_index + 1;
break;
}
}
}
for (absolute_index = 0; absolute_index < count; absolute_index++)
{
struct cache_file_tag_instance *instance = &global_tag_instances[(start + absolute_index) % count];
if (instance->group_tag == group_tag)
{
*name = instance->name;
return instance->tag_index;
}
}
return NONE;
}
#endif
long tag_loaded(
long group_tag,
char const *name)
{
short absolute_index;
long result = NONE;
if (cache_file_globals.tags_loaded)
{
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
346,
global_tag_instances);
for (absolute_index = 0;
absolute_index < cache_file_globals.tag_header->tag_count;
absolute_index++)
{
if (group_tag == global_tag_instances[absolute_index].group_tag &&
!_stricmp(name, global_tag_instances[absolute_index].name))
{
result = global_tag_instances[absolute_index].tag_index;
break;
}
}
}
return result;
}
void cache_files_enable_writes(
void)
{
XPhysicalProtect((void *)0x803A6000, 0x01600000, PAGE_READWRITE);
return;
}
void cache_files_disable_writes(
void)
{
XPhysicalProtect((void *)0x803A6000, 0x01600000, PAGE_READONLY);
XPhysicalProtect(
cache_file_globals.tag_header->vertex_buffers,
cache_file_globals.tag_header->vertex_buffer_count * 12,
PAGE_READWRITE);
XPhysicalProtect(
cache_file_globals.tag_header->index_buffers,
cache_file_globals.tag_header->index_buffer_count * 12,
PAGE_READWRITE);
if (cache_file_globals.structure_bsp_header)
{
XPhysicalProtect(
cache_file_globals.structure_bsp_header->vertex_buffers,
cache_file_globals.structure_bsp_header->vertex_buffer_count * 12,
PAGE_READWRITE);
XPhysicalProtect(
cache_file_globals.structure_bsp_header->index_buffers,
cache_file_globals.structure_bsp_header->index_buffer_count * 12,
PAGE_READWRITE);
}
return;
}
boolean tag_block_resize(
struct tag_block *block,
long count)
{
error(_error_silent, "tag_block_resize() is not supported with a cache file active");
return FALSE;
}
boolean tag_data_resize(
struct tag_data *data,
long size)
{
error(_error_silent, "tag_data_resize() is not supported with a cache file active");
return FALSE;
}
long tag_block_add_element(
struct tag_block *block)
{
error(_error_silent, "tag_block_add_element() is not supported with a cache file active");
return NONE;
}
void tag_block_delete_element(
struct tag_block *block,
long element_index)
{
error(_error_silent, "tag_block_delete_element() is not supported with a cache file active");
return;
}
long tag_load(
long group_tag,
char const *name,
unsigned long flags)
{
error(_error_silent, "tag_load() is not supported with a cache file active");
return NONE;
}
void tag_unload(
long tag_index)
{
error(_error_silent, "tag_unload() is not supported with a cache file active");
return;
}
void tag_file_get_path(
long group_tag,
char const *name,
char *path)
{
error(_error_silent, "tag_file_get_path() is not supported with a cache file active");
path[0] = 0;
return;
}
void tag_reference_set(
struct tag_reference *reference,
unsigned long group_tag,
char const *name)
{
error(_error_silent, "tag_reference_set() is not supported with a cache file active");
return;
}
void tag_iterator_new(
struct tag_iterator *iterator,
long group_tag)
{
iterator->absolute_index = 0;
iterator->group_tag = group_tag;
return;
}
long tag_iterator_next(
struct tag_iterator *iterator)
{
long result = NONE;
while (iterator->absolute_index < cache_file_globals.tag_header->tag_count)
{
struct cache_file_tag_instance *tag_instance =
&global_tag_instances[iterator->absolute_index++];
if (tag_instance &&
(iterator->group_tag == NONE ||
iterator->group_tag == tag_instance->group_tag ||
iterator->group_tag == tag_instance->parent_group_tags[0] ||
iterator->group_tag == tag_instance->parent_group_tags[1]))
{
result = tag_instance->tag_index;
break;
}
}
return result;
}
boolean cache_file_header_verify(
struct cache_file_header *header,
char const *scenario_name,
boolean fatal)
{
if (header->header_signature != CACHE_FILE_HEADER_SIGNATURE ||
header->footer_signature != CACHE_FILE_FOOTER_SIGNATURE ||
header->file_length < 0 ||
header->file_length > 0x11600000 ||
csstrlen(header->name) > 31)
{
if (fatal)
{
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
544,
FALSE,
csprintf(temporary, "'%s' does not appear to be a cache file", scenario_name));
}
return FALSE;
}
if (header->version != 5)
{
if (fatal)
{
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
548,
FALSE,
csprintf(temporary, "the cache file '%s' is an old version", scenario_name));
}
return FALSE;
}
#ifndef HALO_LINUX
/* (the native builds try a cache file whatever build made it, NTSC's
01.10.12.2276 included) */
if (csstrcmp(header->build, "01.01.14.2342"))
{
if (fatal)
{
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
553,
FALSE,
csprintf(
temporary,
"the cache file '%s' belongs to a different build (%s)",
header->name,
header->build));
}
return FALSE;
}
#endif
return TRUE;
}
boolean cache_files_give_time_to_precache(
char const *map_name)
{
boolean result = FALSE;
if (cache_files_precache_map_loaded(map_name))
{
result = TRUE;
}
else
{
if (cache_files_precache_in_progress() &&
!cache_files_precache_is_copying_map(map_name))
{
cache_files_precache_map_end();
}
if (cache_files_precache_in_progress())
{
real progress;
short status = cache_files_precache_map_status(&progress);
if (status == 2)
display_error_damaged_media();
else if (status == 1)
cache_files_precache_map_end();
}
else
{
cache_files_precache_set_priority(0);
if (!cache_files_precache_map_begin(map_name, FALSE))
display_error_damaged_media();
}
}
return result;
}
long scenario_tags_load(
char const *scenario_name)
{
long result;
char const *stripped_scenario_name;
void *tag_cache_base_address;
boolean read_complete;
stripped_scenario_name = tag_name_strip_path(scenario_name);
result = NONE;
texture_cache_open();
sound_cache_open();
if (cache_file_open(stripped_scenario_name, &cache_file_globals.header))
{
tag_cache_base_address = physical_memory_get_tag_cache_base_address();
if (cache_file_header_verify(&cache_file_globals.header, scenario_name, TRUE))
{
csmemset(tag_cache_base_address, 0xCD, 0x01600000);
cache_file_read(
NONE,
cache_file_globals.header.tag_data_offset,
cache_file_globals.header.tag_data_size,
tag_cache_base_address,
&read_complete,
TRUE);
while (!read_complete)
{
SwitchToThread();
}
cache_file_globals.tag_header = tag_cache_base_address;
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
0x94,
cache_file_globals.tag_header->signature == CACHE_FILE_TAG_HEADER_SIGNATURE,
csprintf(
temporary,
"signature is '%c%c%c%c', should be '%c%c%c%c'",
((char *)&cache_file_globals.tag_header->signature)[3],
((char *)&cache_file_globals.tag_header->signature)[2],
((char *)&cache_file_globals.tag_header->signature)[1],
((char *)&cache_file_globals.tag_header->signature)[0],
't',
'a',
'g',
's'));
global_tag_instances = cache_file_globals.tag_header->tag_instances;
tags_header_register_vertex_and_index_buffers(cache_file_globals.tag_header);
cache_file_globals.tags_loaded = TRUE;
result = cache_file_globals.tag_header->scenario_tag_index;
}
}
return result;
}
boolean scenario_structure_bsp_load(
struct scenario_structure_bsp_reference *reference)
{
struct cache_file_tag_instance *tag_instance;
byte *tag_cache_base_address;
tag_cache_base_address = physical_memory_get_tag_cache_base_address();
csmemset(
tag_cache_base_address + cache_file_globals.header.tag_data_size,
0xCD,
0x01600000 - cache_file_globals.header.tag_data_size);
{
boolean read_complete;
cache_file_read(
NONE,
reference->file_offset,
reference->file_size,
reference->base_address,
&read_complete,
TRUE);
while (!read_complete)
{
SwitchToThread();
if (system_milliseconds() - sound_render_time() > 33)
{
sound_idle();
}
}
}
cache_file_globals.structure_bsp_header = reference->base_address;
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
0xE0,
cache_file_globals.structure_bsp_header->signature==CACHE_FILE_STRUCTURE_BSP_HEADER_SIGNATURE);
structure_bsp_header_register_vertex_buffers(cache_file_globals.structure_bsp_header);
tag_instance = cache_get_tag_instance(reference->structure_bsp.index);
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
0xEA,
!tag_instance->base_address);
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
0xEB,
tag_instance->group_tag==STRUCTURE_BSP_TAG);
tag_instance->base_address = cache_file_globals.structure_bsp_header->base_address;
return TRUE;
}
void scenario_structure_bsp_unload(
struct scenario_structure_bsp_reference *reference)
{
struct cache_file_tag_instance *tag_instance;
structure_bsp_header_deregister_vertex_buffers(cache_file_globals.structure_bsp_header);
tag_instance = cache_get_tag_instance(reference->structure_bsp.index);
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
256,
tag_instance->base_address);
match_assert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
257,
tag_instance->group_tag==STRUCTURE_BSP_TAG);
tag_instance->base_address = NULL;
cache_file_globals.structure_bsp_header = NULL;
return;
}
void *tag_get(
long group_tag,
long tag_index)
{
char expected_group[16];
char returned_group[16];
struct cache_file_tag_instance *tag_instance = cache_get_tag_instance(tag_index);
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
298,
tag_instance->group_tag == group_tag ||
tag_instance->parent_group_tags[0] == group_tag ||
tag_instance->parent_group_tags[1] == group_tag,
csprintf(
temporary,
"expected tag group '%s' but got '%s' for %08x",
tag_to_string(group_tag, expected_group),
tag_to_string(tag_instance->group_tag, returned_group),
tag_index)
);
match_vassert(
"c:\\halo\\SOURCE\\cache\\cache_files.c",
302,
tag_instance->base_address,
csprintf(temporary, "can't get() a tag with a base address!")
);
return tag_instance->base_address;
}
char *tag_get_name(
long tag_index)
{
return cache_get_tag_instance(tag_index)->name;
}
unsigned long tag_get_group_tag(
long tag_index)
{
return cache_get_tag_instance(tag_index)->group_tag;
}