fix out-of-bound access in sram (#95)

Updates the requirements on [eframe](https://github.com/emilk/egui) to permit the latest version.
- [Release notes](https://github.com/emilk/egui/releases)
- [Changelog](https://github.com/emilk/egui/blob/master/CHANGELOG.md)
- [Commits](https://github.com/emilk/egui/compare/0.29.0...0.30.0)

---
updated-dependencies:
- dependency-name: eframe
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.cargo/config.toml

@@ -1,8 +1,2 @@
-[target.x86_64-unknown-linux-gnu]
+[target.'cfg(target_arch = "x86_64")']
 rustflags = ["-C", "target-cpu=x86-64-v3"]
-
-[target.x86_64-pc-windows-msvc]
-rustflags = ["-C", "target-cpu=x86-64-v3"]
-
-[target.x86_64-apple-darwin]
-rustflags = ["-C", "target-cpu=x86-64-v2"]

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: loganmc10
+patreon: loganmc10

.github/workflows/build.yml

@@ -26,7 +26,7 @@ jobs:
         run: |
           cargo build --release -v
       - name: Upload file
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: gopher64-linux
           path: target/release/gopher64
@@ -44,13 +44,13 @@ jobs:
         run: |
           cargo build --release -v
       - name: Upload file
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: gopher64-windows
           path: target/release/gopher64.exe
 
   build-macos:
-    runs-on: macos-latest
+    runs-on: macos-13
     steps:
       - uses: actions/checkout@v4
         with:
@@ -65,7 +65,7 @@ jobs:
         run: |
           cargo build --release -v
       - name: Upload file
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: gopher64-mac
           path: target/release/gopher64

Cargo.toml

@@ -1,28 +1,28 @@
 [package]
 name = "gopher64"
-version = "0.1.0"
+version = "0.1.11"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 dirs = "5.0"
-zip = "0.6"
-governor = "0.6"
-sevenz-rust = "0.5"
+zip = "2.1"
+governor = "0.8"
+sevenz-rust = "0.6"
 chrono = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-eframe = "0.23"
-rfd = {version = "0.12",  default-features = false, features = ["xdg-portal"] }
+eframe = "0.30"
+rfd = "0.15"
 sha2 = "0.10"
 rusttype = "0.9"
 futures = "0.3"
-sdl2-sys = { git = "https://github.com/Rust-SDL2/rust-sdl2.git" }
+sdl2-sys = "0.37"
 clap = { version = "4.4", features = ["derive"] }
 
 [dependencies.sdl2]
-git = "https://github.com/Rust-SDL2/rust-sdl2.git"
+version = "0.37"
 default-features = false
 features = ["static-link","bundled"]
 

README.md

@@ -56,4 +56,4 @@ Gopher64 is licensed under the GPLv3 license. Many portions of gopher64 have bee
 
 ## where to download
 
-Builds can be found as artifacts on [GitHub Actions](https://github.com/gopher64/gopher64/actions?query=branch%3Amain)
+https://github.com/gopher64/gopher64/releases

build.rs

@@ -37,6 +37,7 @@ fn main() {
         .file("parallel-rdp/parallel-rdp-standalone/util/aligned_alloc.cpp")
         .file("parallel-rdp/parallel-rdp-standalone/util/timer.cpp")
         .file("parallel-rdp/parallel-rdp-standalone/util/timeline_trace_file.cpp")
+        .file("parallel-rdp/parallel-rdp-standalone/util/environment.cpp")
         .file("parallel-rdp/parallel-rdp-standalone/util/thread_name.cpp")
         .file("parallel-rdp/parallel-rdp-standalone/volk/volk.c")
         .file("parallel-rdp/interface.cpp")
@@ -50,6 +51,10 @@ fn main() {
 
     #[cfg(target_os = "windows")]
     {
+        #[cfg(target_arch = "x86_64")]
+        {
+            build.flag("/arch:AVX2");
+        }
         build.flag("-DVK_USE_PLATFORM_WIN32_KHR");
 
         winres::WindowsResource::new()
@@ -59,6 +64,10 @@ fn main() {
     }
     #[cfg(any(target_os = "linux", target_os = "macos"))]
     {
+        #[cfg(target_arch = "x86_64")]
+        {
+            build.flag("-march=x86-64-v3");
+        }
         build
             .flag("-Wno-missing-field-initializers")
             .flag("-Wno-unused-parameter");

parallel-rdp/interface.cpp

@@ -184,11 +184,15 @@ int sdl_event_filter(void *userdata, SDL_Event *event)
 {
 	if (event->type == SDL_WINDOWEVENT)
 	{
+		SDL_WSIPlatform *platform = (SDL_WSIPlatform *)&wsi->get_platform();
 		switch (event->window.event)
 		{
 		case SDL_WINDOWEVENT_CLOSE:
 			emu_running = 0;
 			break;
+		case SDL_WINDOWEVENT_RESIZED:
+			platform->do_resize();
+			break;
 		default:
 			break;
 		}

parallel-rdp/wsi_platform.cpp

@@ -54,7 +54,17 @@ void SDL_WSIPlatform::poll_input()
 	SDL_PumpEvents();
 }
 
+void SDL_WSIPlatform::poll_input_async(Granite::InputTrackerHandler *handler)
+{
+	SDL_PumpEvents();
+}
+
 void SDL_WSIPlatform::set_window(SDL_Window *_window)
 {
 	window = _window;
 }
+
+void SDL_WSIPlatform::do_resize()
+{
+	resize = true;
+}

parallel-rdp/wsi_platform.hpp

@@ -13,9 +13,10 @@ public:
 	uint32_t get_surface_height() override;
 	bool alive(Vulkan::WSI &wsi) override;
 	void poll_input() override;
+	void poll_input_async(Granite::InputTrackerHandler *handler) override;
 	void set_window(SDL_Window *_window);
+	void do_resize();
 
 private:
-	VkSurfaceKHR surface;
 	SDL_Window *window;
 };

rust-toolchain.toml

@@ -1,2 +0,0 @@
-[toolchain]
-channel = "nightly"

src/device.rs

@@ -247,7 +247,7 @@ impl Device {
                     enabled: false,
                     count: u64::MAX,
                     handler: events::dummy_event,
-                }; events::EventType::EventTypeCount as usize],
+                }; events::EventType::Count as usize],
                 next_event_count: u64::MAX,
                 next_event: 0,
             },

src/device/cart_rom.rs

@@ -80,14 +80,16 @@ pub fn dma_read(
     cart_addr &= CART_MASK as u32;
 
     for i in 0..length {
-        device.cart.rom[(cart_addr + i) as usize] =
-            device.rdram.mem[(dram_addr + i) as usize ^ device.byte_swap];
+        if cart_addr + i < device.cart.rom.len() as u32 {
+            device.cart.rom[(cart_addr + i) as usize] =
+                device.rdram.mem[(dram_addr + i) as usize ^ device.byte_swap];
 
-        device.ui.saves.romsave.0.insert(
-            (cart_addr + i).to_string(),
-            serde_json::to_value(device.rdram.mem[(dram_addr + i) as usize ^ device.byte_swap])
-                .unwrap(),
-        );
+            device.ui.saves.romsave.0.insert(
+                (cart_addr + i).to_string(),
+                serde_json::to_value(device.rdram.mem[(dram_addr + i) as usize ^ device.byte_swap])
+                    .unwrap(),
+            );
+        }
     }
 
     device.ui.saves.romsave.1 = true;
@@ -127,6 +129,9 @@ pub fn init(device: &mut device::Device, rom_file: Vec<u8>) {
     device.ui.game_hash = calculate_hash(&device.cart.rom);
 
     device.ui.game_id = String::from_utf8(device.cart.rom[0x3B..0x3E].to_vec()).unwrap();
+    if device.ui.game_id.contains('\0') {
+        device.ui.game_id = String::from("UNK");
+    }
 }
 
 pub fn load_rom_save(device: &mut device::Device) {

src/device/cpu.rs

@@ -31,7 +31,7 @@ pub struct Cpu {
     pub instrs: [fn(&mut device::Device, u32); 64],
     pub special_instrs: [fn(&mut device::Device, u32); 64],
     pub regimm_instrs: [fn(&mut device::Device, u32); 32],
-    pub events: [device::events::Event; device::events::EventType::EventTypeCount as usize],
+    pub events: [device::events::Event; device::events::EventType::Count as usize],
     pub next_event_count: u64,
     pub next_event: usize,
 }

src/device/events.rs

@@ -11,7 +11,7 @@ pub enum EventType {
     InterruptCheck,
     SPDma,
     Compare,
-    EventTypeCount,
+    Count,
 }
 
 #[derive(PartialEq, Copy, Clone)]

src/device/rsp_interface.rs

@@ -165,11 +165,14 @@ pub fn do_dma(device: &mut device::Device, dma: RspDma) {
         while j < count {
             let mut i = 0;
             while i < length {
-                let data = u32::from_ne_bytes(
-                    device.rdram.mem[dram_addr as usize..dram_addr as usize + 4]
-                        .try_into()
-                        .unwrap(),
-                );
+                let mut data = 0;
+                if dram_addr < device::rdram::RDRAM_SIZE as u32 {
+                    data = u32::from_ne_bytes(
+                        device.rdram.mem[dram_addr as usize..dram_addr as usize + 4]
+                            .try_into()
+                            .unwrap(),
+                    );
+                }
                 if offset != 0 {
                     // imem being updated
                     device.rsp.cpu.instructions[((mem_addr & 0xFFF) / 4) as usize].func =

src/device/sram.rs

@@ -141,7 +141,7 @@ pub fn dma_read_sram(
 
     format_sram(device);
 
-    while i < dram_addr + length {
+    while i < dram_addr + length && i < device::rdram::RDRAM_SIZE as u32 {
         device.ui.saves.sram.0[j as usize] = device.rdram.mem[i as usize ^ device.byte_swap];
         i += 1;
         j += 1;
@@ -191,7 +191,7 @@ pub fn dma_write_sram(
 
     format_sram(device);
 
-    while i < dram_addr + length {
+    while i < dram_addr + length && i < device::rdram::RDRAM_SIZE as u32 {
         device.rdram.mem[i as usize ^ device.byte_swap] = device.ui.saves.sram.0[j as usize];
         i += 1;
         j += 1;

src/main.rs

@@ -1,5 +1,3 @@
-#![feature(round_ties_even)]
-#![feature(string_remove_matches)]
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
 
 mod device;
@@ -122,13 +120,13 @@ fn main() {
         }
     } else {
         let options = eframe::NativeOptions {
-            initial_window_size: Some(eframe::egui::vec2(640.0, 480.0)),
+            viewport: eframe::egui::ViewportBuilder::default().with_inner_size([640.0, 480.0]),
             ..Default::default()
         };
         eframe::run_native(
             "gopher64",
             options,
-            Box::new(|_cc| Box::new(ui::gui::GopherEguiApp::new())),
+            Box::new(|_cc| Ok(Box::new(ui::gui::GopherEguiApp::new()))),
         )
         .unwrap();
     }

src/ui.rs

@@ -18,6 +18,7 @@ pub struct Ui {
     pub video_subsystem: Option<sdl2::VideoSubsystem>,
     pub audio_subsystem: Option<sdl2::AudioSubsystem>,
     pub joystick_subsystem: Option<sdl2::JoystickSubsystem>,
+    #[allow(dead_code)]
     pub controller_subsystem: Option<sdl2::GameControllerSubsystem>,
     pub window: Option<sdl2::video::Window>,
     pub audio_device: Option<sdl2::audio::AudioQueue<i16>>,

src/ui/gui.rs

@@ -115,7 +115,9 @@ impl eframe::App for GopherEguiApp {
                                 ui::input::configure_input_profile(&mut game_ui, profile_name);
                             });
                             self.configure_profile = false;
-                            if !self.profile_name.is_empty() && self.profile_name != "default" {
+                            if !self.profile_name.is_empty()
+                                && !self.input_profiles.contains(&self.profile_name)
+                            {
                                 self.input_profiles.push(self.profile_name.clone())
                             }
                         };
@@ -127,7 +129,9 @@ impl eframe::App for GopherEguiApp {
         }
 
         egui::CentralPanel::default().show(ctx, |ui| {
-            ui.set_enabled(!self.configure_profile);
+            if self.configure_profile {
+                ui.disable()
+            }
 
             if ui.button("Open ROM").clicked() {
                 // Spawn dialog on main thread
@@ -175,7 +179,7 @@ impl eframe::App for GopherEguiApp {
                 for i in 0..4 {
                     ui.label(format!("{}", i + 1));
 
-                    egui::ComboBox::from_id_source(format!("profile-combo-{}", i))
+                    egui::ComboBox::from_id_salt(format!("profile-combo-{}", i))
                         .selected_text(self.selected_profile[i].clone())
                         .show_ui(ui, |ui| {
                             for j in 0..self.input_profiles.len() {
@@ -192,7 +196,7 @@ impl eframe::App for GopherEguiApp {
                     } else {
                         self.controllers[self.selected_controller[i] as usize].clone()
                     };
-                    egui::ComboBox::from_id_source(format!("controller-combo-{}", i))
+                    egui::ComboBox::from_id_salt(format!("controller-combo-{}", i))
                         .selected_text(controller_text)
                         .show_ui(ui, |ui| {
                             ui.selectable_value(

src/ui/input.rs

@@ -87,28 +87,36 @@ pub fn set_axis_from_controller(
         let mut y = 0.0;
         if profile.controller_axis[AXIS_LEFT].0 {
             let axis_position =
-                controller.axis(std::mem::transmute(profile.controller_axis[AXIS_LEFT].1));
+                controller.axis(std::mem::transmute::<i32, sdl2::controller::Axis>(
+                    profile.controller_axis[AXIS_LEFT].1,
+                ));
             if axis_position as isize * profile.controller_axis[AXIS_LEFT].2 as isize > 0 {
                 x = axis_position as f64 * MAX_AXIS_VALUE / i16::MAX as f64;
             }
         }
         if profile.controller_axis[AXIS_RIGHT].0 {
             let axis_position =
-                controller.axis(std::mem::transmute(profile.controller_axis[AXIS_RIGHT].1));
+                controller.axis(std::mem::transmute::<i32, sdl2::controller::Axis>(
+                    profile.controller_axis[AXIS_RIGHT].1,
+                ));
             if axis_position as isize * profile.controller_axis[AXIS_RIGHT].2 as isize > 0 {
                 x = axis_position as f64 * MAX_AXIS_VALUE / i16::MAX as f64;
             }
         }
         if profile.controller_axis[AXIS_DOWN].0 {
             let axis_position =
-                controller.axis(std::mem::transmute(profile.controller_axis[AXIS_DOWN].1));
+                controller.axis(std::mem::transmute::<i32, sdl2::controller::Axis>(
+                    profile.controller_axis[AXIS_DOWN].1,
+                ));
             if axis_position as isize * profile.controller_axis[AXIS_DOWN].2 as isize > 0 {
                 y = (axis_position as f64 * MAX_AXIS_VALUE / i16::MAX as f64).neg();
             }
         }
         if profile.controller_axis[AXIS_UP].0 {
             let axis_position =
-                controller.axis(std::mem::transmute(profile.controller_axis[AXIS_UP].1));
+                controller.axis(std::mem::transmute::<i32, sdl2::controller::Axis>(
+                    profile.controller_axis[AXIS_UP].1,
+                ));
             if axis_position as isize * profile.controller_axis[AXIS_UP].2 as isize > 0 {
                 y = (axis_position as f64 * MAX_AXIS_VALUE / i16::MAX as f64).neg();
             }
@@ -125,22 +133,34 @@ pub fn set_axis_from_keys(
         let mut x = 0.0;
         let mut y = 0.0;
         if profile.keys[AXIS_LEFT].0
-            && keyboard_state.is_scancode_pressed(std::mem::transmute(profile.keys[AXIS_LEFT].1))
+            && keyboard_state
+                .is_scancode_pressed(std::mem::transmute::<i32, sdl2::keyboard::Scancode>(
+                    profile.keys[AXIS_LEFT].1,
+                ))
         {
             x = -MAX_AXIS_VALUE
         }
         if profile.keys[AXIS_RIGHT].0
-            && keyboard_state.is_scancode_pressed(std::mem::transmute(profile.keys[AXIS_RIGHT].1))
+            && keyboard_state
+                .is_scancode_pressed(std::mem::transmute::<i32, sdl2::keyboard::Scancode>(
+                    profile.keys[AXIS_RIGHT].1,
+                ))
         {
             x = MAX_AXIS_VALUE
         }
         if profile.keys[AXIS_DOWN].0
-            && keyboard_state.is_scancode_pressed(std::mem::transmute(profile.keys[AXIS_DOWN].1))
+            && keyboard_state
+                .is_scancode_pressed(std::mem::transmute::<i32, sdl2::keyboard::Scancode>(
+                    profile.keys[AXIS_DOWN].1,
+                ))
         {
             y = -MAX_AXIS_VALUE
         }
         if profile.keys[AXIS_UP].0
-            && keyboard_state.is_scancode_pressed(std::mem::transmute(profile.keys[AXIS_UP].1))
+            && keyboard_state
+                .is_scancode_pressed(std::mem::transmute::<i32, sdl2::keyboard::Scancode>(
+                    profile.keys[AXIS_UP].1,
+                ))
         {
             y = MAX_AXIS_VALUE
         }
@@ -162,7 +182,9 @@ pub fn set_buttons_from_joystick(
     let profile_joystick_hat = profile.joystick_hat[i];
     if profile_joystick_hat.0
         && joystick.hat(profile_joystick_hat.1).unwrap()
-            == unsafe { std::mem::transmute(profile_joystick_hat.2) }
+            == unsafe {
+                std::mem::transmute::<i8, sdl2::joystick::HatState>(profile_joystick_hat.2)
+            }
     {
         *keys |= 1 << i;
     }
@@ -187,15 +209,20 @@ pub fn set_buttons_from_controller(
     let profile_controller_button = profile.controller_buttons[i];
     if profile_controller_button.0 {
         unsafe {
-            *keys |=
-                (controller.button(std::mem::transmute(profile_controller_button.1)) as u32) << i;
+            *keys |= (controller.button(std::mem::transmute::<i32, sdl2::controller::Button>(
+                profile_controller_button.1,
+            )) as u32)
+                << i;
         }
     }
 
     let profile_controller_axis = profile.controller_axis[i];
     if profile_controller_axis.0 {
-        let axis_position =
-            unsafe { controller.axis(std::mem::transmute(profile_controller_axis.1)) };
+        let axis_position = unsafe {
+            controller.axis(std::mem::transmute::<i32, sdl2::controller::Axis>(
+                profile_controller_axis.1,
+            ))
+        };
         if axis_position as isize * profile_controller_axis.2 as isize > 0
             && axis_position.saturating_abs() > i16::MAX / 2
         {
@@ -219,8 +246,10 @@ pub fn get(ui: &mut ui::Ui, channel: usize) -> u32 {
             let profile_key = profile.keys[i];
             if profile_key.0 {
                 unsafe {
-                    keys |= (keyboard_state.is_scancode_pressed(std::mem::transmute(profile_key.1))
-                        as u32)
+                    keys |= (keyboard_state
+                        .is_scancode_pressed(std::mem::transmute::<i32, sdl2::keyboard::Scancode>(
+                            profile_key.1,
+                        )) as u32)
                         << i;
                 }
             }
@@ -377,8 +406,13 @@ pub fn configure_input_profile(ui: &mut ui::Ui, profile: String) {
                         key_set = true
                     }
                     sdl2::event::Event::JoyHatMotion { hat_idx, state, .. } => {
-                        new_joystick_hat[*value] =
-                            unsafe { (true, hat_idx as u32, std::mem::transmute(state)) };
+                        new_joystick_hat[*value] = unsafe {
+                            (
+                                true,
+                                hat_idx as u32,
+                                std::mem::transmute::<sdl2::joystick::HatState, i8>(state),
+                            )
+                        };
                         key_set = true
                     }
                     sdl2::event::Event::JoyAxisMotion {

src/ui/storage.rs

@@ -97,27 +97,27 @@ pub fn init(ui: &mut ui::Ui) {
         panic!("could not create save dir")
     }
 
-    ui.paths.eep_file_path = base_path.clone();
+    ui.paths.eep_file_path.clone_from(&base_path);
     ui.paths
         .eep_file_path
         .push(ui.game_id.to_owned() + "-" + &ui.game_hash + ".eep");
 
-    ui.paths.sra_file_path = base_path.clone();
+    ui.paths.sra_file_path.clone_from(&base_path);
     ui.paths
         .sra_file_path
         .push(ui.game_id.to_owned() + "-" + &ui.game_hash + ".sra");
 
-    ui.paths.fla_file_path = base_path.clone();
+    ui.paths.fla_file_path.clone_from(&base_path);
     ui.paths
         .fla_file_path
         .push(ui.game_id.to_owned() + "-" + &ui.game_hash + ".fla");
 
-    ui.paths.pak_file_path = base_path.clone();
+    ui.paths.pak_file_path.clone_from(&base_path);
     ui.paths
         .pak_file_path
         .push(ui.game_id.to_owned() + "-" + &ui.game_hash + ".mpk");
 
-    ui.paths.romsave_file_path = base_path.clone();
+    ui.paths.romsave_file_path.clone_from(&base_path);
     ui.paths
         .romsave_file_path
         .push(ui.game_id.to_owned() + "-" + &ui.game_hash + ".romsave");

src/ui/video.rs

@@ -1,6 +1,6 @@
 use crate::ui;
 
-extern "C" {
+unsafe extern "C" {
     pub fn vk_init(rdram_ptr: usize, rdram_size: u32, fullscreen: u8);
     pub fn set_sdl_window(window: usize);
     pub fn rdp_update_screen() -> u8;