Move the system heap and the framebuffers to their own segments (#1488)

* make segments for the systemheap and the framebuffers

* define in the makefile

* undefined syms

* Make segments for the pre boot buffers too

* Update spec

Co-authored-by: Parker <20159000+jpburnett@users.noreply.github.com>

* review

* Update spec

Co-authored-by: Parker <20159000+jpburnett@users.noreply.github.com>

* Update Makefile

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* comments

* comment

* move comment about the hardcoded address to buffers.h

* rewrite SYSTEM_HEAP_END_ADDR in terms of other symbols

* Use `ALIGNED` on all the buffers

* Rename SYSTEM_HEAP_END_ADDR to FRAMEBUFFERS_START_ADDR

* Put ALIGNED at the right like the rest of the codebase

* merge

* gLoBuffer

* gHiBuffer

* Add a static assert to ensure the address of gHiBuffer haven't shifted without the user noticing

* smol include cleanup

---------

Co-authored-by: Parker <20159000+jpburnett@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

src/boot/idle.c

@@ -1,4 +1,5 @@
 #include "prevent_bss_reordering.h"
+#include "buffers.h"
 #include "irqmgr.h"
 #include "main.h"
 #include "stack.h"
@@ -41,10 +42,10 @@ void Main_InitFramebuffer(u32* framebuffer, size_t numBytes, u32 value) {
 }
 
 void Main_InitScreen(void) {
-    Main_InitFramebuffer((u32*)gFramebuffer1, sizeof(gFramebuffer1),
+    Main_InitFramebuffer((u32*)gLoBuffer.framebuffer, sizeof(gLoBuffer.framebuffer),
                          (GPACK_RGBA5551(0, 0, 0, 1) << 16) | GPACK_RGBA5551(0, 0, 0, 1));
     ViConfig_UpdateVi(false);
-    osViSwapBuffer(gFramebuffer1);
+    osViSwapBuffer(gLoBuffer.framebuffer);
     osViBlack(false);
 }
 
@@ -52,9 +53,13 @@ void Main_InitMemory(void) {
     void* memStart = (void*)0x80000400;
     void* memEnd = OS_PHYSICAL_TO_K0(osMemSize);
 
-    Main_ClearMemory(memStart, gFramebuffer1);
-    Main_ClearMemory(D_80025D00, bootproc);
-    Main_ClearMemory(gGfxSPTaskYieldBuffer, memEnd);
+    Main_ClearMemory(memStart, SEGMENT_START(framebuffer_lo));
+
+    // Clear the rest of the buffer that was not initialized by Main_InitScreen
+    Main_ClearMemory(&gLoBuffer.skyboxBuffer, SEGMENT_END(framebuffer_lo));
+
+    // Clear all the buffers after the `code` segment, up to the end of the available RAM space
+    Main_ClearMemory(SEGMENT_END(code), memEnd);
 }
 
 void Main_Init(void) {

src/buffers/audio_heap.c

@@ -0,0 +1,3 @@
+#include "buffers.h"
+
+u8 gAudioHeap[0x138000] ALIGNED(16);

src/buffers/framebuffer_hi.c

@@ -0,0 +1,5 @@
+#include "buffers.h"
+
+// Don't add symbols here unless you know what you are doing.
+
+BufferHigh gHiBuffer ALIGNED(64);

src/buffers/framebuffer_lo.c

@@ -0,0 +1,5 @@
+#include "buffers.h"
+
+// Don't add symbols here unless you know what you are doing.
+
+BufferLow gLoBuffer ALIGNED(64);

src/buffers/gfxpools.c

@@ -1,3 +1,3 @@
 #include "buffers.h"
 
-GfxPool gGfxPools[2];
+GfxPool gGfxPools[2] ALIGNED(16);

src/buffers/gfxstack.c

@@ -1,3 +1,3 @@
 #include "buffers.h"
 
-STACK(gGfxSPTaskStack, 0x400);
+STACK(gGfxSPTaskStack, 0x400) ALIGNED(16);

src/buffers/gfxyield.c

@@ -1,3 +1,3 @@
 #include "buffers.h"
 
-u8 gGfxSPTaskYieldBuffer[OS_YIELD_DATA_SIZE];
+u8 gGfxSPTaskYieldBuffer[OS_YIELD_DATA_SIZE] ALIGNED(16);

src/buffers/heaps.c

@@ -1,5 +0,0 @@
-#include "buffers.h"
-
-u8 gAudioHeap[0x138000];
-
-u8 gSystemHeap[UNK_SIZE];

src/buffers/system_heap.c

@@ -0,0 +1,6 @@
+#include "buffers.h"
+
+// Don't add symbols here unless you know what you are doing.
+
+// Dummy, marks the start of system_heap space whose actual size depends on the spec
+u8 gSystemHeap[UNK_SIZE] ALIGNED(16);

src/code/main.c

@@ -53,8 +53,8 @@ void Main(void* arg) {
     Check_RegionIsSupported();
     Check_ExpansionPak();
 
-    sysHeap = (intptr_t)gSystemHeap;
-    fb = 0x80780000;
+    sysHeap = (intptr_t)SEGMENT_START(system_heap);
+    fb = FRAMEBUFFERS_START_ADDR;
     gSystemHeapSize = fb - sysHeap;
     SystemHeap_Init((void*)sysHeap, gSystemHeapSize);
 

src/code/sys_cfb.c

@@ -1,5 +1,5 @@
-#include "prevent_bss_reordering.h"
 #include "z64.h"
+#include "buffers.h"
 #include "regs.h"
 #include "functions.h"
 #include "macros.h"
@@ -41,9 +41,6 @@ u8 gSysCfbHiResEnabled;
 #include "system_malloc.h"
 #include "z64vimode.h"
 
-extern u16 gFramebufferHiRes0[HIRES_BUFFER_WIDTH][HIRES_BUFFER_HEIGHT];
-extern u16 gFramebufferHiRes1[HIRES_BUFFER_WIDTH][HIRES_BUFFER_HEIGHT];
-
 void SysCfb_SetLoResMode(void) {
     gFramebuffers[1] = sCfbLoRes1;
     gFramebuffers[0] = sCfbLoRes0;
@@ -93,8 +90,8 @@ void SysCfb_SetHiResMode(void) {
 }
 
 void SysCfb_Init(void) {
-    sCfbLoRes1 = gFramebuffer1;
-    sCfbLoRes0 = gFramebuffer0;
+    sCfbLoRes1 = gLoBuffer.framebuffer;
+    sCfbLoRes0 = gHiBuffer.framebuffer;
     sCfbHiRes1 = gFramebufferHiRes1;
     sCfbHiRes0 = gFramebufferHiRes0;
     SysCfb_SetLoResMode();

src/code/z_play.c

@@ -248,7 +248,7 @@ void Play_TriggerPictoPhoto(void) {
 
 void Play_TakePictoPhoto(PreRender* prerender) {
     PreRender_ApplyFilters(prerender);
-    Play_ConvertRgba16ToIntensityImage(gPictoPhotoI8, prerender->fbufSave, SCREEN_WIDTH, PICTO_PHOTO_TOPLEFT_X,
+    Play_ConvertRgba16ToIntensityImage(gHiBuffer.pictoPhotoI8, prerender->fbufSave, SCREEN_WIDTH, PICTO_PHOTO_TOPLEFT_X,
                                        PICTO_PHOTO_TOPLEFT_Y, (PICTO_PHOTO_TOPLEFT_X + PICTO_PHOTO_WIDTH) - 1,
                                        (PICTO_PHOTO_TOPLEFT_Y + PICTO_PHOTO_HEIGHT) - 1, 8);
 }
@@ -2262,10 +2262,10 @@ void Play_Init(GameState* thisx) {
     PreRender_SetValues(&this->pauseBgPreRender, gCfbWidth, gCfbHeight, NULL, NULL);
 
     this->unk_18E64 = gWorkBuffer;
-    this->pictoPhotoI8 = gPictoPhotoI8;
-    this->unk_18E68 = D_80784600;
-    this->unk_18E58 = D_80784600;
-    this->unk_18E60 = D_80784600;
+    this->pictoPhotoI8 = gHiBuffer.pictoPhotoI8;
+    this->unk_18E68 = gHiBuffer.D_80784600;
+    this->unk_18E58 = gHiBuffer.D_80784600;
+    this->unk_18E60 = gHiBuffer.D_80784600;
     gTransitionTileState = TRANS_TILE_OFF;
     this->transitionMode = TRANS_MODE_OFF;
     D_801D0D54 = false;

src/code/z_vr_box.c

@@ -1,4 +1,5 @@
 #include "global.h"
+#include "buffers.h"
 
 u32 D_801C5E30[] = { 0, 0x2000, 0x4000, 0x6000, 0x8000, 0xC000 };
 
@@ -193,7 +194,7 @@ void Skybox_Setup(GameState* gameState, SkyboxContext* skyboxCtx, s16 skyboxId)
     switch (skyboxId) {
         case SKYBOX_NORMAL_SKY:
             // Send a DMA request for the cloudy sky texture
-            skyboxCtx->staticSegments[0] = &D_80025D00;
+            skyboxCtx->staticSegments[0] = gLoBuffer.skyboxBuffer;
             size = SEGMENT_ROM_SIZE(d2_cloud_static);
             segment = (void*)ALIGN8((uintptr_t)skyboxCtx->staticSegments[0] + size);
             DmaMgr_SendRequest0(skyboxCtx->staticSegments[0], SEGMENT_ROM_START(d2_cloud_static), size);