From d3834ed2ff046751686031b351d9ccf50feab33c Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 20:48:04 +0100 Subject: [PATCH 01/37] allocator unsound to use in interrupt --- agb/src/agb_alloc/block_allocator.rs | 41 ++++++++++++++-------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/agb/src/agb_alloc/block_allocator.rs b/agb/src/agb_alloc/block_allocator.rs index 14eb4638..921a4308 100644 --- a/agb/src/agb_alloc/block_allocator.rs +++ b/agb/src/agb_alloc/block_allocator.rs @@ -5,13 +5,10 @@ use core::alloc::{Allocator, GlobalAlloc, Layout}; -use core::cell::RefCell; +use core::cell::UnsafeCell; use core::convert::TryInto; use core::ptr::NonNull; -use crate::interrupt::free; -use bare_metal::Mutex; - use super::bump_allocator::{BumpAllocatorInner, StartEnd}; use super::SendNonNull; @@ -53,36 +50,45 @@ struct BlockAllocatorInner { } pub struct BlockAllocator { - inner: Mutex>, + inner: UnsafeCell, } +unsafe impl Sync for BlockAllocator {} + impl BlockAllocator { pub(crate) const unsafe fn new(start: StartEnd) -> Self { Self { - inner: Mutex::new(RefCell::new(BlockAllocatorInner::new(start))), + inner: UnsafeCell::new(BlockAllocatorInner::new(start)), } } + #[inline(always)] + unsafe fn with_inner(&self, f: F) -> T + where + F: Fn(&mut BlockAllocatorInner) -> T, + { + let inner = &mut *self.inner.get(); + + f(inner) + } + #[doc(hidden)] #[cfg(any(test, feature = "testing"))] pub unsafe fn number_of_blocks(&self) -> u32 { - free(|key| self.inner.borrow(key).borrow_mut().number_of_blocks()) + self.with_inner(|inner| inner.number_of_blocks()) } pub unsafe fn alloc(&self, layout: Layout) -> Option> { - free(|key| self.inner.borrow(key).borrow_mut().alloc(layout)) + self.with_inner(|inner| inner.alloc(layout)) } pub unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) { - free(|key| self.inner.borrow(key).borrow_mut().dealloc(ptr, layout)); + self.with_inner(|inner| inner.dealloc(ptr, layout)); } pub unsafe fn dealloc_no_normalise(&self, ptr: *mut u8, layout: Layout) { - free(|key| { - self.inner - .borrow(key) - .borrow_mut() - .dealloc_no_normalise(ptr, layout); + self.with_inner(|inner| { + inner.dealloc_no_normalise(ptr, layout); }); } @@ -92,12 +98,7 @@ impl BlockAllocator { layout: Layout, new_layout: Layout, ) -> Option> { - free(|key| { - self.inner - .borrow(key) - .borrow_mut() - .grow(ptr, layout, new_layout) - }) + self.with_inner(|inner| inner.grow(ptr, layout, new_layout)) } } From 16c3395524d59b4fdcf8dbb288eaac7635605940 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 21:09:44 +0100 Subject: [PATCH 02/37] Really basic elf parser --- agb-gbafix/.gitignore | 1 + agb-gbafix/Cargo.lock | 16 ++++++++++++++ agb-gbafix/Cargo.toml | 9 ++++++++ agb-gbafix/src/main.rs | 47 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 73 insertions(+) create mode 100644 agb-gbafix/.gitignore create mode 100644 agb-gbafix/Cargo.lock create mode 100644 agb-gbafix/Cargo.toml create mode 100644 agb-gbafix/src/main.rs diff --git a/agb-gbafix/.gitignore b/agb-gbafix/.gitignore new file mode 100644 index 00000000..0b512c76 --- /dev/null +++ b/agb-gbafix/.gitignore @@ -0,0 +1 @@ +!Cargo.lock \ No newline at end of file diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock new file mode 100644 index 00000000..4677f650 --- /dev/null +++ b/agb-gbafix/Cargo.lock @@ -0,0 +1,16 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "agb-gbafix" +version = "0.1.0" +dependencies = [ + "elf", +] + +[[package]] +name = "elf" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2b183d6ce6ca4cf30e3db37abf5b52568b5f9015c97d9fbdd7026aa5dcdd758" diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml new file mode 100644 index 00000000..ee86b776 --- /dev/null +++ b/agb-gbafix/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "agb-gbafix" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +elf = "0.7" \ No newline at end of file diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs new file mode 100644 index 00000000..e3c0d3a4 --- /dev/null +++ b/agb-gbafix/src/main.rs @@ -0,0 +1,47 @@ +use std::{ + fs, + io::{self, Write}, + path::PathBuf, +}; + +fn main() -> Result<(), Box> { + let path = PathBuf::from("tests/text_render"); + let file_data = fs::read(path)?; + let file_data = file_data.as_slice(); + + let elf_file = elf::ElfBytes::::minimal_parse(file_data)?; + + let (section_headers, strtab) = elf_file.section_headers_with_strtab()?; + let section_headers = section_headers.expect("Expected section headers"); + let strtab = strtab.expect("Expected string table"); + + let output = fs::File::create("out.gba")?; + let mut buf_writer = io::BufWriter::new(output); + + for section_header in section_headers.iter() { + let section_name = strtab.get(section_header.sh_name as usize)?; + + const SHT_NOBITS: u32 = 8; + const SHT_NULL: u32 = 0; + const SHF_ALLOC: u64 = 2; + + if (section_header.sh_type == SHT_NOBITS || section_header.sh_type == SHT_NULL) + || section_header.sh_flags & SHF_ALLOC == 0 + { + continue; + } + + println!("{section_name}"); + + let (data, compression) = elf_file.section_data(§ion_header)?; + if let Some(compression) = compression { + panic!("Cannot compress elf content, but got compression header {compression:?}"); + } + + buf_writer.write_all(data)?; + } + + buf_writer.flush()?; + + Ok(()) +} From aa77255720ceb50282467c91e19cac474eb8a752 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 21:10:03 +0100 Subject: [PATCH 03/37] Correct error message --- agb-gbafix/src/main.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index e3c0d3a4..1f07d457 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -35,7 +35,7 @@ fn main() -> Result<(), Box> { let (data, compression) = elf_file.section_data(§ion_header)?; if let Some(compression) = compression { - panic!("Cannot compress elf content, but got compression header {compression:?}"); + panic!("Cannot decompress elf content, but got compression header {compression:?}"); } buf_writer.write_all(data)?; From dffda47985d9e47c2c7ddcbc0a3d8012afaff730 Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:16:13 +0100 Subject: [PATCH 04/37] resolve interrupts unsoundness --- agb/examples/output.rs | 15 +++-- agb/examples/wave.rs | 27 ++++---- agb/src/interrupt.rs | 79 ++++++++---------------- agb/src/sound/mixer/sw_mixer.rs | 10 +-- agb/src/sync/statics.rs | 106 +++++++++++++++++--------------- 5 files changed, 111 insertions(+), 126 deletions(-) diff --git a/agb/examples/output.rs b/agb/examples/output.rs index 93b8595a..8aabc69d 100644 --- a/agb/examples/output.rs +++ b/agb/examples/output.rs @@ -3,13 +3,16 @@ use agb::sync::Static; +static COUNT: Static = Static::new(0); + #[agb::entry] fn main(_gba: agb::Gba) -> ! { - let count = Static::new(0); - let _a = agb::interrupt::add_interrupt_handler(agb::interrupt::Interrupt::VBlank, |_| { - let cur_count = count.read(); - agb::println!("Hello, world, frame = {}", cur_count); - count.write(cur_count + 1); - }); + let _a = unsafe { + agb::interrupt::add_interrupt_handler(agb::interrupt::Interrupt::VBlank, |_| { + let cur_count = COUNT.read(); + agb::println!("Hello, world, frame = {}", cur_count); + COUNT.write(cur_count + 1); + }) + }; loop {} } diff --git a/agb/examples/wave.rs b/agb/examples/wave.rs index 491c0e0b..1e9cf223 100644 --- a/agb/examples/wave.rs +++ b/agb/examples/wave.rs @@ -18,6 +18,11 @@ struct BackCosines { row: usize, } +static BACK: Mutex> = Mutex::new(RefCell::new(BackCosines { + cosines: [0; 32], + row: 0, +})); + #[agb::entry] fn main(mut gba: agb::Gba) -> ! { let (gfx, mut vram) = gba.display.video.tiled0(); @@ -30,24 +35,22 @@ fn main(mut gba: agb::Gba) -> ! { example_logo::display_logo(&mut background, &mut vram); - let mut time = 0; - let cosines = [0_u16; 32]; - - let back = Mutex::new(RefCell::new(BackCosines { cosines, row: 0 })); - - let _a = agb::interrupt::add_interrupt_handler(Interrupt::HBlank, |key: CriticalSection| { - let mut back = back.borrow(key).borrow_mut(); - let deflection = back.cosines[back.row % 32]; - unsafe { ((0x0400_0010) as *mut u16).write_volatile(deflection) } - back.row += 1; - }); + let _a = unsafe { + agb::interrupt::add_interrupt_handler(Interrupt::HBlank, |key: CriticalSection| { + let mut back = BACK.borrow(key).borrow_mut(); + let deflection = back.cosines[back.row % 32]; + ((0x0400_0010) as *mut u16).write_volatile(deflection); + back.row += 1; + }) + }; let vblank = agb::interrupt::VBlank::get(); + let mut time = 0; loop { vblank.wait_for_vblank(); free(|key| { - let mut back = back.borrow(key).borrow_mut(); + let mut back = BACK.borrow(key).borrow_mut(); back.row = 0; time += 1; for (r, a) in back.cosines.iter_mut().enumerate() { diff --git a/agb/src/interrupt.rs b/agb/src/interrupt.rs index 68aa0789..83c30357 100644 --- a/agb/src/interrupt.rs +++ b/agb/src/interrupt.rs @@ -1,8 +1,4 @@ -use core::{ - cell::Cell, - marker::{PhantomData, PhantomPinned}, - pin::Pin, -}; +use core::{cell::Cell, marker::PhantomPinned, pin::Pin}; use alloc::boxed::Box; use bare_metal::CriticalSection; @@ -206,9 +202,8 @@ impl Drop for InterruptInner { } } -pub struct InterruptHandler<'a> { +pub struct InterruptHandler { _inner: Pin>, - _lifetime: PhantomData<&'a ()>, } impl InterruptRoot { @@ -231,6 +226,13 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// Adds an interrupt handler as long as the returned value is alive. The /// closure takes a [`CriticalSection`] which can be used for mutexes. /// +/// SAFETY: +/// * You *must not* allocate in an interrupt. +/// +/// STATICNESS: +/// * The closure must be static because forgetting the interrupt handler will +/// cause a use after free. +/// /// [`CriticalSection`]: bare_metal::CriticalSection /// /// # Examples @@ -247,14 +249,11 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// }); /// # } /// ``` -pub fn add_interrupt_handler<'a>( +pub unsafe fn add_interrupt_handler( interrupt: Interrupt, - handler: impl Fn(CriticalSection) + Send + Sync + 'a, -) -> InterruptHandler<'a> { - fn do_with_inner<'a>( - interrupt: Interrupt, - inner: Pin>, - ) -> InterruptHandler<'a> { + handler: impl Fn(CriticalSection) + Send + Sync + 'static, +) -> InterruptHandler { + fn do_with_inner(interrupt: Interrupt, inner: Pin>) -> InterruptHandler { free(|_| { let root = interrupt_to_root(interrupt); root.add(); @@ -274,10 +273,7 @@ pub fn add_interrupt_handler<'a>( } }); - InterruptHandler { - _inner: inner, - _lifetime: PhantomData, - } + InterruptHandler { _inner: inner } } let root = interrupt_to_root(interrupt) as *const _; let inner = unsafe { create_interrupt_inner(handler, root) }; @@ -322,9 +318,12 @@ impl VBlank { #[must_use] pub fn get() -> Self { if !HAS_CREATED_INTERRUPT.read() { - let handler = add_interrupt_handler(Interrupt::VBlank, |_| { - NUM_VBLANKS.write(NUM_VBLANKS.read() + 1); - }); + // safety: we don't allocate in the interrupt + let handler = unsafe { + add_interrupt_handler(Interrupt::VBlank, |_| { + NUM_VBLANKS.write(NUM_VBLANKS.read() + 1); + }) + }; core::mem::forget(handler); HAS_CREATED_INTERRUPT.write(true); @@ -351,36 +350,6 @@ impl VBlank { #[cfg(test)] mod tests { use super::*; - use bare_metal::Mutex; - use core::cell::RefCell; - - #[test_case] - fn test_can_create_and_destroy_interrupt_handlers(_gba: &mut crate::Gba) { - let mut counter = Mutex::new(RefCell::new(0)); - let counter_2 = Mutex::new(RefCell::new(0)); - - let vblank = VBlank::get(); - - { - let _a = add_interrupt_handler(Interrupt::VBlank, |key: CriticalSection| { - *counter.borrow(key).borrow_mut() += 1; - }); - let _b = add_interrupt_handler(Interrupt::VBlank, |key: CriticalSection| { - *counter_2.borrow(key).borrow_mut() += 1; - }); - - while free(|key| { - *counter.borrow(key).borrow() < 100 || *counter_2.borrow(key).borrow() < 100 - }) { - vblank.wait_for_vblank(); - } - } - - vblank.wait_for_vblank(); - vblank.wait_for_vblank(); - - assert_eq!(*counter.get_mut().get_mut(), 100); - } #[test_case] fn test_interrupt_table_length(_gba: &mut crate::Gba) { @@ -406,7 +375,9 @@ pub fn profiler(timer: &mut crate::timer::Timer, period: u16) -> InterruptHandle timer.set_overflow_amount(period); timer.set_enabled(true); - add_interrupt_handler(timer.interrupt(), |_key: CriticalSection| { - crate::println!("{:#010x}", crate::program_counter_before_interrupt()); - }) + unsafe { + add_interrupt_handler(timer.interrupt(), |_key: CriticalSection| { + crate::println!("{:#010x}", crate::program_counter_before_interrupt()); + }) + } } diff --git a/agb/src/sound/mixer/sw_mixer.rs b/agb/src/sound/mixer/sw_mixer.rs index 4f32e786..8984f842 100644 --- a/agb/src/sound/mixer/sw_mixer.rs +++ b/agb/src/sound/mixer/sw_mixer.rs @@ -82,7 +82,7 @@ extern "C" { pub struct Mixer<'gba> { interrupt_timer: Timer, // SAFETY: Has to go before buffer because it holds a reference to it - _interrupt_handler: InterruptHandler<'static>, + _interrupt_handler: InterruptHandler, buffer: Pin>, channels: [Option; 8], @@ -140,9 +140,11 @@ impl Mixer<'_> { // In the case of the mixer being forgotten, both stay alive so okay let buffer_pointer_for_interrupt_handler: &MixerBuffer = unsafe { core::mem::transmute(buffer_pointer_for_interrupt_handler) }; - let interrupt_handler = add_interrupt_handler(interrupt_timer.interrupt(), |cs| { - buffer_pointer_for_interrupt_handler.swap(cs); - }); + let interrupt_handler = unsafe { + add_interrupt_handler(interrupt_timer.interrupt(), |cs| { + buffer_pointer_for_interrupt_handler.swap(cs); + }) + }; set_asm_buffer_size(frequency); diff --git a/agb/src/sync/statics.rs b/agb/src/sync/statics.rs index 69536c6c..68eb5030 100644 --- a/agb/src/sync/statics.rs +++ b/agb/src/sync/statics.rs @@ -267,65 +267,71 @@ mod test { use crate::timer::Divider; use crate::Gba; - fn write_read_concurrency_test_impl(gba: &mut Gba) { - let sentinel = [0x12345678; COUNT]; - let value: Static<[u32; COUNT]> = Static::new(sentinel); + macro_rules! generate_concurrency_test { + ($count:literal, $gba:ident) => {{ + (|gba: &mut Gba| { + const SENTINEL: [u32; $count] = [0x12345678; $count]; + static VALUE: Static<[u32; $count]> = Static::new(SENTINEL); - // set up a timer and an interrupt that uses the timer - let mut timer = gba.timers.timers().timer2; - timer.set_cascade(false); - timer.set_divider(Divider::Divider1); - timer.set_overflow_amount(1049); - timer.set_interrupt(true); - timer.set_enabled(true); + // set up a timer and an interrupt that uses the timer + let mut timer = gba.timers.timers().timer2; + timer.set_cascade(false); + timer.set_divider(Divider::Divider1); + timer.set_overflow_amount(1049); + timer.set_interrupt(true); + timer.set_enabled(true); - let _int = crate::interrupt::add_interrupt_handler(Interrupt::Timer2, |_| { - value.write(sentinel); - }); + let _int = unsafe { + crate::interrupt::add_interrupt_handler(Interrupt::Timer2, |_| { + VALUE.write(SENTINEL); + }) + }; - // the actual main test loop - let mut interrupt_seen = false; - let mut no_interrupt_seen = false; - for i in 0..250000 { - // write to the static - let new_value = [i; COUNT]; - value.write(new_value); + // the actual main test loop + let mut interrupt_seen = false; + let mut no_interrupt_seen = false; + for i in 0..250000 { + // write to the static + let new_value = [i; $count]; + VALUE.write(new_value); - // check the current value - let current = value.read(); - if current == new_value { - no_interrupt_seen = true; - } else if current == sentinel { - interrupt_seen = true; - } else { - panic!("Unexpected value found in `Static`."); - } + // check the current value + let current = VALUE.read(); + if current == new_value { + no_interrupt_seen = true; + } else if current == SENTINEL { + interrupt_seen = true; + } else { + panic!("Unexpected value found in `Static`."); + } - // we return as soon as we've seen both the value written by the main thread - // and interrupt - if interrupt_seen && no_interrupt_seen { - timer.set_enabled(false); - return; - } + // we return as soon as we've seen both the value written by the main thread + // and interrupt + if interrupt_seen && no_interrupt_seen { + timer.set_enabled(false); + return; + } - if i % 8192 == 0 && i != 0 { - timer.set_overflow_amount(1049 + (i / 64) as u16); - } - } - panic!("Concurrency test timed out: {}", COUNT) + if i % 8192 == 0 && i != 0 { + timer.set_overflow_amount(1049 + (i / 64) as u16); + } + } + panic!("Concurrency test timed out: {}", $count) + })($gba); + }}; } #[test_case] fn write_read_concurrency_test(gba: &mut Gba) { - write_read_concurrency_test_impl::<1>(gba); - write_read_concurrency_test_impl::<2>(gba); - write_read_concurrency_test_impl::<3>(gba); - write_read_concurrency_test_impl::<4>(gba); - write_read_concurrency_test_impl::<5>(gba); - write_read_concurrency_test_impl::<6>(gba); - write_read_concurrency_test_impl::<7>(gba); - write_read_concurrency_test_impl::<8>(gba); - write_read_concurrency_test_impl::<9>(gba); - write_read_concurrency_test_impl::<10>(gba); + generate_concurrency_test!(1, gba); + generate_concurrency_test!(2, gba); + generate_concurrency_test!(3, gba); + generate_concurrency_test!(4, gba); + generate_concurrency_test!(5, gba); + generate_concurrency_test!(6, gba); + generate_concurrency_test!(7, gba); + generate_concurrency_test!(8, gba); + generate_concurrency_test!(9, gba); + generate_concurrency_test!(10, gba); } } From 96a321504cd644820050f91022c30493e802bf58 Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:17:33 +0100 Subject: [PATCH 05/37] correct doc sections --- agb/src/interrupt.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/agb/src/interrupt.rs b/agb/src/interrupt.rs index 83c30357..26099f9d 100644 --- a/agb/src/interrupt.rs +++ b/agb/src/interrupt.rs @@ -226,10 +226,10 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// Adds an interrupt handler as long as the returned value is alive. The /// closure takes a [`CriticalSection`] which can be used for mutexes. /// -/// SAFETY: +/// # Safety /// * You *must not* allocate in an interrupt. /// -/// STATICNESS: +/// # Staticness /// * The closure must be static because forgetting the interrupt handler will /// cause a use after free. /// From 686ded4377946ceea2cb15085115015ec9536c4f Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:28:52 +0100 Subject: [PATCH 06/37] fix doc example --- agb/src/interrupt.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/agb/src/interrupt.rs b/agb/src/interrupt.rs index 26099f9d..fc0ad9dc 100644 --- a/agb/src/interrupt.rs +++ b/agb/src/interrupt.rs @@ -228,6 +228,7 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// /// # Safety /// * You *must not* allocate in an interrupt. +/// - Many functions in agb allocate and it isn't always clear. /// /// # Staticness /// * The closure must be static because forgetting the interrupt handler will @@ -240,12 +241,14 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// ```rust,no_run /// # #![no_std] /// # #![no_main] -/// use bare_metal::CriticalSection; -/// /// # fn foo() { -/// # use agb::interrupt::{add_interrupt_handler, Interrupt}; -/// let _a = add_interrupt_handler(Interrupt::VBlank, |_: CriticalSection| { -/// agb::println!("Woah there! There's been a vblank!"); +/// use bare_metal::CriticalSection; +/// use agb::interrupt::{add_interrupt_handler, Interrupt}; +/// // Safety: doesn't allocate +/// let _a = unsafe { +/// add_interrupt_handler(Interrupt::VBlank, |_: CriticalSection| { +/// agb::println!("Woah there! There's been a vblank!"); +/// } /// }); /// # } /// ``` From 69b1ea5e479d2336247aee7654db8888c931435e Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:47:21 +0100 Subject: [PATCH 07/37] fix brackets --- agb/src/interrupt.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/agb/src/interrupt.rs b/agb/src/interrupt.rs index fc0ad9dc..dda401fc 100644 --- a/agb/src/interrupt.rs +++ b/agb/src/interrupt.rs @@ -248,8 +248,8 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// let _a = unsafe { /// add_interrupt_handler(Interrupt::VBlank, |_: CriticalSection| { /// agb::println!("Woah there! There's been a vblank!"); -/// } -/// }); +/// }) +/// }; /// # } /// ``` pub unsafe fn add_interrupt_handler( From 44ef68d1eadf77eeaac5f5f40fb250af185c93c6 Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:49:30 +0100 Subject: [PATCH 08/37] note the breaking change --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4404d6fd..32b268f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - The template now uses rust 2021 edition by default. - All objects which should only be created once now have the correct lifetimes to only allow one to exist. - Template now uses codegen-units=1 to workaround bug in nightly. +- Soundness issues with interrupts resolved which makes them unsafe and require the closure to be static (breaking change). ### Fixed - Alpha channel is now considered by `include_gfx!()` even when `transparent_colour` is absent. From d08ce9c85bfb3434583c4b6b91822095c7785445 Mon Sep 17 00:00:00 2001 From: Corwin Date: Thu, 6 Apr 2023 21:53:18 +0100 Subject: [PATCH 09/37] note allocator change --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 32b268f5..e0999975 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - The template now uses rust 2021 edition by default. - All objects which should only be created once now have the correct lifetimes to only allow one to exist. - Template now uses codegen-units=1 to workaround bug in nightly. +- Allocator is no longer interrupt safe. - Soundness issues with interrupts resolved which makes them unsafe and require the closure to be static (breaking change). ### Fixed From dce7a6726e6bad5b43a9b514f64b7cf527dc0075 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 21:54:26 +0100 Subject: [PATCH 10/37] Add the correct header --- agb-gbafix/Cargo.lock | 17 +++++++++++++++++ agb-gbafix/Cargo.toml | 4 +++- agb-gbafix/src/main.rs | 40 +++++++++++++++++++++++++++------------- 3 files changed, 47 insertions(+), 14 deletions(-) diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock index 4677f650..e23beada 100644 --- a/agb-gbafix/Cargo.lock +++ b/agb-gbafix/Cargo.lock @@ -6,11 +6,28 @@ version = 3 name = "agb-gbafix" version = "0.1.0" dependencies = [ + "bytemuck", "elf", + "gbafix", ] +[[package]] +name = "bytemuck" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "17febce684fd15d89027105661fec94afb475cb995fbc59d2865198446ba2eea" + [[package]] name = "elf" version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e2b183d6ce6ca4cf30e3db37abf5b52568b5f9015c97d9fbdd7026aa5dcdd758" + +[[package]] +name = "gbafix" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f7e47af9d5377b8b0def53d9916f6c28521f2e5b97c5fec137797417c26ab4b7" +dependencies = [ + "bytemuck", +] diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index ee86b776..de91941c 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -6,4 +6,6 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -elf = "0.7" \ No newline at end of file +elf = "0.7" +gbafix = "1" +bytemuck = "1" \ No newline at end of file diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 1f07d457..039c1896 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -1,6 +1,6 @@ use std::{ fs, - io::{self, Write}, + io::{BufWriter, Write}, path::PathBuf, }; @@ -11,16 +11,16 @@ fn main() -> Result<(), Box> { let elf_file = elf::ElfBytes::::minimal_parse(file_data)?; - let (section_headers, strtab) = elf_file.section_headers_with_strtab()?; - let section_headers = section_headers.expect("Expected section headers"); - let strtab = strtab.expect("Expected string table"); + let section_headers = elf_file + .section_headers() + .expect("Expected section headers"); - let output = fs::File::create("out.gba")?; - let mut buf_writer = io::BufWriter::new(output); + let mut output = BufWriter::new(fs::File::create("out.gba")?); + let mut header = gbafix::GBAHeader::default(); + + let mut written_header = false; for section_header in section_headers.iter() { - let section_name = strtab.get(section_header.sh_name as usize)?; - const SHT_NOBITS: u32 = 8; const SHT_NULL: u32 = 0; const SHF_ALLOC: u64 = 2; @@ -31,17 +31,31 @@ fn main() -> Result<(), Box> { continue; } - println!("{section_name}"); - - let (data, compression) = elf_file.section_data(§ion_header)?; + let (mut data, compression) = elf_file.section_data(§ion_header)?; if let Some(compression) = compression { panic!("Cannot decompress elf content, but got compression header {compression:?}"); } - buf_writer.write_all(data)?; + if !written_header { + assert!( + data.len() > 192, + "first section must be at least as big as the gba header" + ); + + header.start_code = data[0..4].try_into().unwrap(); + header.update_checksum(); + + let header_bytes = bytemuck::bytes_of(&header); + output.write_all(header_bytes)?; + + data = &data[192..]; + written_header = true; + } + + output.write_all(data)?; } - buf_writer.flush()?; + output.flush()?; Ok(()) } From a111a41deb9c71aed27d69f7c0fb37e4acb12980 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 21:55:11 +0100 Subject: [PATCH 11/37] Extract constant --- agb-gbafix/src/main.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 039c1896..88747d80 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -37,8 +37,10 @@ fn main() -> Result<(), Box> { } if !written_header { + const GBA_HEADER_SIZE: usize = 192; + assert!( - data.len() > 192, + data.len() > GBA_HEADER_SIZE, "first section must be at least as big as the gba header" ); @@ -48,7 +50,7 @@ fn main() -> Result<(), Box> { let header_bytes = bytemuck::bytes_of(&header); output.write_all(header_bytes)?; - data = &data[192..]; + data = &data[GBA_HEADER_SIZE..]; written_header = true; } From 07318256e0883901e2a0d5bc37b247a2ffab03d5 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:09:19 +0100 Subject: [PATCH 12/37] Generate correct 0 bytes --- agb-gbafix/src/main.rs | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 88747d80..de7e9fb1 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -19,7 +19,9 @@ fn main() -> Result<(), Box> { let mut header = gbafix::GBAHeader::default(); - let mut written_header = false; + const GBA_START_ADDRESS: u64 = 0x8000000; + let mut address = GBA_START_ADDRESS; + for section_header in section_headers.iter() { const SHT_NOBITS: u32 = 8; const SHT_NULL: u32 = 0; @@ -31,12 +33,16 @@ fn main() -> Result<(), Box> { continue; } + for _ in address..section_header.sh_addr { + output.write_all(&[0])?; + } + let (mut data, compression) = elf_file.section_data(§ion_header)?; if let Some(compression) = compression { panic!("Cannot decompress elf content, but got compression header {compression:?}"); } - if !written_header { + if address == GBA_START_ADDRESS { const GBA_HEADER_SIZE: usize = 192; assert!( @@ -51,10 +57,11 @@ fn main() -> Result<(), Box> { output.write_all(header_bytes)?; data = &data[GBA_HEADER_SIZE..]; - written_header = true; + address += GBA_HEADER_SIZE as u64; } output.write_all(data)?; + address += data.len() as u64; } output.flush()?; From d278d50528c13b6ab1dbe9e1da688e835e4ca99d Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:13:42 +0100 Subject: [PATCH 13/37] Extract function --- agb-gbafix/src/main.rs | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index de7e9fb1..263a8011 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -1,22 +1,29 @@ use std::{ - fs, + error, fs, io::{BufWriter, Write}, path::PathBuf, }; -fn main() -> Result<(), Box> { +fn main() -> Result<(), Box> { + let mut output = BufWriter::new(fs::File::create("out.gba")?); + let path = PathBuf::from("tests/text_render"); let file_data = fs::read(path)?; - let file_data = file_data.as_slice(); - let elf_file = elf::ElfBytes::::minimal_parse(file_data)?; + write_gba_file(file_data.as_slice(), &mut output)?; + + output.flush()?; + + Ok(()) +} + +fn write_gba_file(input: &[u8], output: &mut W) -> Result<(), Box> { + let elf_file = elf::ElfBytes::::minimal_parse(input)?; let section_headers = elf_file .section_headers() .expect("Expected section headers"); - let mut output = BufWriter::new(fs::File::create("out.gba")?); - let mut header = gbafix::GBAHeader::default(); const GBA_START_ADDRESS: u64 = 0x8000000; @@ -64,7 +71,5 @@ fn main() -> Result<(), Box> { address += data.len() as u64; } - output.flush()?; - Ok(()) } From b76781799ae81c310192377b0235d815063498e2 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:16:38 +0100 Subject: [PATCH 14/37] Use anyhow for errors --- agb-gbafix/Cargo.lock | 7 +++++++ agb-gbafix/Cargo.toml | 3 ++- agb-gbafix/src/main.rs | 14 ++++++++------ 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock index e23beada..6510f171 100644 --- a/agb-gbafix/Cargo.lock +++ b/agb-gbafix/Cargo.lock @@ -6,11 +6,18 @@ version = 3 name = "agb-gbafix" version = "0.1.0" dependencies = [ + "anyhow", "bytemuck", "elf", "gbafix", ] +[[package]] +name = "anyhow" +version = "1.0.70" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7de8ce5e0f9f8d88245311066a578d72b7af3e7088f32783804676302df237e4" + [[package]] name = "bytemuck" version = "1.13.1" diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index de91941c..deb9792b 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -8,4 +8,5 @@ edition = "2021" [dependencies] elf = "0.7" gbafix = "1" -bytemuck = "1" \ No newline at end of file +bytemuck = "1" +anyhow = "1" \ No newline at end of file diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 263a8011..0bade60f 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -1,10 +1,12 @@ +use anyhow::{anyhow, bail, ensure, Result}; + use std::{ - error, fs, + fs, io::{BufWriter, Write}, path::PathBuf, }; -fn main() -> Result<(), Box> { +fn main() -> Result<()> { let mut output = BufWriter::new(fs::File::create("out.gba")?); let path = PathBuf::from("tests/text_render"); @@ -17,12 +19,12 @@ fn main() -> Result<(), Box> { Ok(()) } -fn write_gba_file(input: &[u8], output: &mut W) -> Result<(), Box> { +fn write_gba_file(input: &[u8], output: &mut W) -> Result<()> { let elf_file = elf::ElfBytes::::minimal_parse(input)?; let section_headers = elf_file .section_headers() - .expect("Expected section headers"); + .ok_or_else(|| anyhow!("Failed to parse as elf file"))?; let mut header = gbafix::GBAHeader::default(); @@ -46,13 +48,13 @@ fn write_gba_file(input: &[u8], output: &mut W) -> Result<(), Box GBA_HEADER_SIZE, "first section must be at least as big as the gba header" ); From 44e0d24f1bb610152eaf78965442112ff04156ec Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:35:44 +0100 Subject: [PATCH 15/37] Pad the result --- agb-gbafix/src/main.rs | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 0bade60f..b837dd92 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -42,8 +42,12 @@ fn write_gba_file(input: &[u8], output: &mut W) -> Result<()> { continue; } - for _ in address..section_header.sh_addr { - output.write_all(&[0])?; + if address < section_header.sh_addr { + for _ in address..section_header.sh_addr { + output.write_all(&[0])?; + } + + address = section_header.sh_addr; } let (mut data, compression) = elf_file.section_data(§ion_header)?; @@ -73,5 +77,15 @@ fn write_gba_file(input: &[u8], output: &mut W) -> Result<()> { address += data.len() as u64; } + let length = address - GBA_START_ADDRESS; + + if !length.is_power_of_two() { + let required_padding = length.next_power_of_two() - length; + + for _ in 0..required_padding { + output.write_all(&[0])?; + } + } + Ok(()) } From 8aa6e3182bc1a2c99ca2443deef47dfa70a7b5e3 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:43:57 +0100 Subject: [PATCH 16/37] Add a CLI --- agb-gbafix/Cargo.lock | 323 +++++++++++++++++++++++++++++++++++++++++ agb-gbafix/Cargo.toml | 3 +- agb-gbafix/src/main.rs | 17 ++- 3 files changed, 339 insertions(+), 4 deletions(-) diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock index 6510f171..79b706be 100644 --- a/agb-gbafix/Cargo.lock +++ b/agb-gbafix/Cargo.lock @@ -8,28 +8,146 @@ version = "0.1.0" dependencies = [ "anyhow", "bytemuck", + "clap", "elf", "gbafix", ] +[[package]] +name = "anstream" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "342258dd14006105c2b75ab1bd7543a03bdf0cfc94383303ac212a04939dff6f" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-wincon", + "concolor-override", + "concolor-query", + "is-terminal", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "0.3.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23ea9e81bd02e310c216d080f6223c179012256e5151c41db88d12c88a1684d2" + +[[package]] +name = "anstyle-parse" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7d1bb534e9efed14f3e5f44e7dd1a4f709384023a4165199a4241e18dff0116" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-wincon" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3127af6145b149f3287bb9a0d10ad9c5692dba8c53ad48285e5bec4063834fa" +dependencies = [ + "anstyle", + "windows-sys 0.45.0", +] + [[package]] name = "anyhow" version = "1.0.70" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7de8ce5e0f9f8d88245311066a578d72b7af3e7088f32783804676302df237e4" +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + [[package]] name = "bytemuck" version = "1.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "17febce684fd15d89027105661fec94afb475cb995fbc59d2865198446ba2eea" +[[package]] +name = "cc" +version = "1.0.79" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50d30906286121d95be3d479533b458f87493b30a4b5f79a607db8f5d11aa91f" + +[[package]] +name = "clap" +version = "4.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "046ae530c528f252094e4a77886ee1374437744b2bff1497aa898bbddbbb29b3" +dependencies = [ + "clap_builder", +] + +[[package]] +name = "clap_builder" +version = "4.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "223163f58c9a40c3b0a43e1c4b50a9ce09f007ea2cb1ec258a687945b4b7929f" +dependencies = [ + "anstream", + "anstyle", + "bitflags", + "clap_lex", + "once_cell", + "strsim", +] + +[[package]] +name = "clap_lex" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a2dd5a6fe8c6e3502f568a6353e5273bbb15193ad9a89e457b9970798efbea1" + +[[package]] +name = "concolor-override" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a855d4a1978dc52fb0536a04d384c2c0c1aa273597f08b77c8c4d3b2eec6037f" + +[[package]] +name = "concolor-query" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88d11d52c3d7ca2e6d0040212be9e4dbbcd78b6447f535b6b561f449427944cf" +dependencies = [ + "windows-sys 0.45.0", +] + [[package]] name = "elf" version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e2b183d6ce6ca4cf30e3db37abf5b52568b5f9015c97d9fbdd7026aa5dcdd758" +[[package]] +name = "errno" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50d6a0976c999d473fe89ad888d5a284e55366d9dc9038b1ba2aa15128c4afa0" +dependencies = [ + "errno-dragonfly", + "libc", + "windows-sys 0.45.0", +] + +[[package]] +name = "errno-dragonfly" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa68f1b12764fab894d2755d2518754e71b4fd80ecfb822714a1206c2aab39bf" +dependencies = [ + "cc", + "libc", +] + [[package]] name = "gbafix" version = "1.0.4" @@ -38,3 +156,208 @@ checksum = "f7e47af9d5377b8b0def53d9916f6c28521f2e5b97c5fec137797417c26ab4b7" dependencies = [ "bytemuck", ] + +[[package]] +name = "hermit-abi" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fed44880c466736ef9a5c5b5facefb5ed0785676d0c02d612db14e54f0d84286" + +[[package]] +name = "io-lifetimes" +version = "1.0.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c66c74d2ae7e79a5a8f7ac924adbe38ee42a859c6539ad869eb51f0b52dc220" +dependencies = [ + "hermit-abi", + "libc", + "windows-sys 0.48.0", +] + +[[package]] +name = "is-terminal" +version = "0.4.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adcf93614601c8129ddf72e2d5633df827ba6551541c6d8c59520a371475be1f" +dependencies = [ + "hermit-abi", + "io-lifetimes", + "rustix", + "windows-sys 0.48.0", +] + +[[package]] +name = "libc" +version = "0.2.141" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3304a64d199bb964be99741b7a14d26972741915b3649639149b2479bb46f4b5" + +[[package]] +name = "linux-raw-sys" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d59d8c75012853d2e872fb56bc8a2e53718e2cafe1a4c823143141c6d90c322f" + +[[package]] +name = "once_cell" +version = "1.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7e5500299e16ebb147ae15a00a942af264cf3688f47923b8fc2cd5858f23ad3" + +[[package]] +name = "rustix" +version = "0.37.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aef160324be24d31a62147fae491c14d2204a3865c7ca8c3b0d7f7bcb3ea635" +dependencies = [ + "bitflags", + "errno", + "io-lifetimes", + "libc", + "linux-raw-sys", + "windows-sys 0.48.0", +] + +[[package]] +name = "strsim" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" + +[[package]] +name = "utf8parse" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" + +[[package]] +name = "windows-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" +dependencies = [ + "windows-targets 0.42.2", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets 0.48.0", +] + +[[package]] +name = "windows-targets" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071" +dependencies = [ + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", +] + +[[package]] +name = "windows-targets" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b1eb6f0cd7c80c79759c929114ef071b87354ce476d9d94271031c0497adfd5" +dependencies = [ + "windows_aarch64_gnullvm 0.48.0", + "windows_aarch64_msvc 0.48.0", + "windows_i686_gnu 0.48.0", + "windows_i686_msvc 0.48.0", + "windows_x86_64_gnu 0.48.0", + "windows_x86_64_gnullvm 0.48.0", + "windows_x86_64_msvc 0.48.0", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91ae572e1b79dba883e0d315474df7305d12f569b400fcf90581b06062f7e1bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2ef27e0d7bdfcfc7b868b317c1d32c641a6fe4629c171b8928c7b08d98d7cf3" + +[[package]] +name = "windows_i686_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "622a1962a7db830d6fd0a69683c80a18fda201879f0f447f065a3b7467daa241" + +[[package]] +name = "windows_i686_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4542c6e364ce21bf45d69fdd2a8e455fa38d316158cfd43b3ac1c5b1b19f8e00" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca2b8a661f7628cbd23440e50b05d705db3686f894fc9580820623656af974b1" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7896dbc1f41e08872e9d5e8f8baa8fdd2677f29468c4e156210174edc7f7b953" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a" diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index deb9792b..901a7f9f 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -9,4 +9,5 @@ edition = "2021" elf = "0.7" gbafix = "1" bytemuck = "1" -anyhow = "1" \ No newline at end of file +anyhow = "1" +clap = { version = "4", features = ["cargo"] } \ No newline at end of file diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index b837dd92..3d4024e8 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -1,4 +1,5 @@ use anyhow::{anyhow, bail, ensure, Result}; +use clap::{arg, command, value_parser}; use std::{ fs, @@ -7,10 +8,20 @@ use std::{ }; fn main() -> Result<()> { - let mut output = BufWriter::new(fs::File::create("out.gba")?); + let matches = command!() + .arg(arg!( "Input elf file").value_parser(value_parser!(PathBuf))) + .arg(arg!(-o --output "Set output file, defaults to replacing INPUT's extension to .gba").value_parser(value_parser!(PathBuf))) + .get_matches(); - let path = PathBuf::from("tests/text_render"); - let file_data = fs::read(path)?; + let input = matches.get_one::("INPUT").unwrap(); + let output = match matches.get_one::("output") { + Some(output) => output.clone(), + None => input.with_extension("gba"), + }; + + let mut output = BufWriter::new(fs::File::create(output)?); + + let file_data = fs::read(input)?; write_gba_file(file_data.as_slice(), &mut output)?; From d81c28a0d0cac072f8fbd22fea0ff2bb55fdf35f Mon Sep 17 00:00:00 2001 From: Gwilym Inzani Date: Thu, 6 Apr 2023 23:56:19 +0100 Subject: [PATCH 17/37] Allow configuration of the header --- agb-gbafix/src/main.rs | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 3d4024e8..9a2e94c7 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -11,6 +11,10 @@ fn main() -> Result<()> { let matches = command!() .arg(arg!( "Input elf file").value_parser(value_parser!(PathBuf))) .arg(arg!(-o --output "Set output file, defaults to replacing INPUT's extension to .gba").value_parser(value_parser!(PathBuf))) + .arg(arg!(-t --title "Set the title. At most 12 bytes")) + .arg(arg!(-c --gamecode <GAME_CODE> "Sets the game code, 4 bytes")) + .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 0-65535").value_parser(value_parser!(u16))) + .arg(arg!(-r --gameversion <VERSION> "Set the version of the game, 0-255").value_parser(value_parser!(u8))) .get_matches(); let input = matches.get_one::<PathBuf>("INPUT").unwrap(); @@ -19,26 +23,49 @@ fn main() -> Result<()> { None => input.with_extension("gba"), }; - let mut output = BufWriter::new(fs::File::create(output)?); + let mut header = gbafix::GBAHeader::default(); + if let Some(title) = matches.get_one::<String>("title") { + for (i, &c) in title.as_bytes().iter().enumerate().take(12) { + header.title[i] = c; + } + } + + if let Some(maker_code) = matches.get_one::<u16>("makercode") { + header.maker_code = maker_code.to_le_bytes(); + } + + if let Some(game_version) = matches.get_one::<u8>("gameversion") { + header.version = *game_version; + } + + if let Some(game_code) = matches.get_one::<String>("gamecode") { + for (i, &c) in game_code.as_bytes().iter().enumerate().take(4) { + header.game_code[i] = c; + } + } + + let mut output = BufWriter::new(fs::File::create(output)?); let file_data = fs::read(input)?; - write_gba_file(file_data.as_slice(), &mut output)?; + write_gba_file(file_data.as_slice(), header, &mut output)?; output.flush()?; Ok(()) } -fn write_gba_file<W: Write>(input: &[u8], output: &mut W) -> Result<()> { +fn write_gba_file<W: Write>( + input: &[u8], + mut header: gbafix::GBAHeader, + output: &mut W, +) -> Result<()> { let elf_file = elf::ElfBytes::<elf::endian::AnyEndian>::minimal_parse(input)?; let section_headers = elf_file .section_headers() .ok_or_else(|| anyhow!("Failed to parse as elf file"))?; - let mut header = gbafix::GBAHeader::default(); - const GBA_START_ADDRESS: u64 = 0x8000000; let mut address = GBA_START_ADDRESS; From e87c90d7adc47b8f62dd413808183f0f46b73de2 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Thu, 6 Apr 2023 23:59:28 +0100 Subject: [PATCH 18/37] Remove cargo feature --- agb-gbafix/Cargo.lock | 7 ------- agb-gbafix/Cargo.toml | 2 +- agb-gbafix/src/main.rs | 5 +++-- 3 files changed, 4 insertions(+), 10 deletions(-) diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock index 79b706be..3bed8d81 100644 --- a/agb-gbafix/Cargo.lock +++ b/agb-gbafix/Cargo.lock @@ -96,7 +96,6 @@ dependencies = [ "anstyle", "bitflags", "clap_lex", - "once_cell", "strsim", ] @@ -198,12 +197,6 @@ version = "0.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d59d8c75012853d2e872fb56bc8a2e53718e2cafe1a4c823143141c6d90c322f" -[[package]] -name = "once_cell" -version = "1.17.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b7e5500299e16ebb147ae15a00a942af264cf3688f47923b8fc2cd5858f23ad3" - [[package]] name = "rustix" version = "0.37.8" diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index 901a7f9f..a1ac8093 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -10,4 +10,4 @@ elf = "0.7" gbafix = "1" bytemuck = "1" anyhow = "1" -clap = { version = "4", features = ["cargo"] } \ No newline at end of file +clap = { version = "4" } \ No newline at end of file diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 9a2e94c7..4dc3e0ab 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -1,5 +1,5 @@ use anyhow::{anyhow, bail, ensure, Result}; -use clap::{arg, command, value_parser}; +use clap::{arg, value_parser}; use std::{ fs, @@ -8,7 +8,8 @@ use std::{ }; fn main() -> Result<()> { - let matches = command!() + let matches = clap::Command::new("agb-gbafix") + .about("Convert elf files directly to a valid GBA ROM") .arg(arg!(<INPUT> "Input elf file").value_parser(value_parser!(PathBuf))) .arg(arg!(-o --output <OUTPUT> "Set output file, defaults to replacing INPUT's extension to .gba").value_parser(value_parser!(PathBuf))) .arg(arg!(-t --title <TITLE> "Set the title. At most 12 bytes")) From b13318f699760a635e2cc4c4e3a322f739e7d1ce Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Fri, 7 Apr 2023 00:03:00 +0100 Subject: [PATCH 19/37] Autogenerate the title --- agb-gbafix/src/main.rs | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 4dc3e0ab..56edbb8c 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -12,7 +12,7 @@ fn main() -> Result<()> { .about("Convert elf files directly to a valid GBA ROM") .arg(arg!(<INPUT> "Input elf file").value_parser(value_parser!(PathBuf))) .arg(arg!(-o --output <OUTPUT> "Set output file, defaults to replacing INPUT's extension to .gba").value_parser(value_parser!(PathBuf))) - .arg(arg!(-t --title <TITLE> "Set the title. At most 12 bytes")) + .arg(arg!(-t --title <TITLE> "Set the title. At most 12 bytes. Defaults to truncating the input file name")) .arg(arg!(-c --gamecode <GAME_CODE> "Sets the game code, 4 bytes")) .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 0-65535").value_parser(value_parser!(u16))) .arg(arg!(-r --gameversion <VERSION> "Set the version of the game, 0-255").value_parser(value_parser!(u8))) @@ -26,7 +26,17 @@ fn main() -> Result<()> { let mut header = gbafix::GBAHeader::default(); - if let Some(title) = matches.get_one::<String>("title") { + { + let title = if let Some(title) = matches.get_one::<String>("title") { + title.clone() + } else { + let title = input + .file_stem() + .ok_or_else(|| anyhow!("Invalid filename {}", input.to_string_lossy()))? + .to_string_lossy(); + title.into_owned() + }; + for (i, &c) in title.as_bytes().iter().enumerate().take(12) { header.title[i] = c; } From 6d28e4193b5609f520932605f94baf348aae5783 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:10:47 +0100 Subject: [PATCH 20/37] Replace objcopy + gbafix to use our own gbafix --- justfile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/justfile b/justfile index d901cce2..1c56a933 100644 --- a/justfile +++ b/justfile @@ -105,11 +105,13 @@ _build-rom folder name: mkdir -p examples/target/examples - arm-none-eabi-objcopy -O binary "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" "$GBA_FILE" - gbafix -p "-t${INTERNAL_NAME:0:12}" "-c${INTERNAL_NAME:0:4}" -mGC "$GBA_FILE" + just _gbafix --title "${INTERNAL_NAME:0:12}" --gamecode "${INTERNAL_NAME:0:4}" "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" -o "$GBA_FILE" cp -v "$GBA_FILE" "examples/target/examples/$GAME_NAME.gba" +_gbafix +args: + (cd agb-gbafix && cargo run --release -- {{args}}) + _all-crates target: for CARGO_PROJECT_FILE in agb-*/Cargo.toml agb/Cargo.toml; do \ PROJECT_DIR=$(dirname "$CARGO_PROJECT_FILE"); \ From 32d19debfb8087170ff1dc92b8d2a23cfc92c90e Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:13:22 +0100 Subject: [PATCH 21/37] Add -p argument for compatibility with stock gbafix --- agb-gbafix/src/main.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 56edbb8c..d3a4e3eb 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -16,6 +16,7 @@ fn main() -> Result<()> { .arg(arg!(-c --gamecode <GAME_CODE> "Sets the game code, 4 bytes")) .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 0-65535").value_parser(value_parser!(u16))) .arg(arg!(-r --gameversion <VERSION> "Set the version of the game, 0-255").value_parser(value_parser!(u8))) + .arg(arg!(-p "Ignored for compatibility with gbafix")) .get_matches(); let input = matches.get_one::<PathBuf>("INPUT").unwrap(); From 89c883466a4728fba276a6270e8067923ebcc601 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:14:11 +0100 Subject: [PATCH 22/37] Allow calling `just gbafix` --- justfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/justfile b/justfile index 1c56a933..8dd3c721 100644 --- a/justfile +++ b/justfile @@ -105,11 +105,11 @@ _build-rom folder name: mkdir -p examples/target/examples - just _gbafix --title "${INTERNAL_NAME:0:12}" --gamecode "${INTERNAL_NAME:0:4}" "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" -o "$GBA_FILE" + just gbafix --title "${INTERNAL_NAME:0:12}" --gamecode "${INTERNAL_NAME:0:4}" "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" -o "$GBA_FILE" cp -v "$GBA_FILE" "examples/target/examples/$GAME_NAME.gba" -_gbafix +args: +gbafix *args: (cd agb-gbafix && cargo run --release -- {{args}}) _all-crates target: From 7ec077e08adb5fb70f60ba490bd921b8aed7ace8 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:18:27 +0100 Subject: [PATCH 23/37] Implement makercode as expected --- agb-gbafix/src/main.rs | 17 ++++++++++++++--- justfile | 2 +- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index d3a4e3eb..7fe07200 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -14,7 +14,7 @@ fn main() -> Result<()> { .arg(arg!(-o --output <OUTPUT> "Set output file, defaults to replacing INPUT's extension to .gba").value_parser(value_parser!(PathBuf))) .arg(arg!(-t --title <TITLE> "Set the title. At most 12 bytes. Defaults to truncating the input file name")) .arg(arg!(-c --gamecode <GAME_CODE> "Sets the game code, 4 bytes")) - .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 0-65535").value_parser(value_parser!(u16))) + .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 2 bytes")) .arg(arg!(-r --gameversion <VERSION> "Set the version of the game, 0-255").value_parser(value_parser!(u8))) .arg(arg!(-p "Ignored for compatibility with gbafix")) .get_matches(); @@ -43,8 +43,19 @@ fn main() -> Result<()> { } } - if let Some(maker_code) = matches.get_one::<u16>("makercode") { - header.maker_code = maker_code.to_le_bytes(); + if let Some(maker_code) = matches.get_one::<String>("makercode") { + let maker_code = maker_code.as_bytes(); + if maker_code.len() > 2 { + bail!( + "Maker code must be at most 2 bytes, got {}", + maker_code.len() + ); + } + + header.maker_code = [ + *maker_code.first().unwrap_or(&0), + *maker_code.get(1).unwrap_or(&0), + ]; } if let Some(game_version) = matches.get_one::<u8>("gameversion") { diff --git a/justfile b/justfile index 8dd3c721..032849cb 100644 --- a/justfile +++ b/justfile @@ -105,7 +105,7 @@ _build-rom folder name: mkdir -p examples/target/examples - just gbafix --title "${INTERNAL_NAME:0:12}" --gamecode "${INTERNAL_NAME:0:4}" "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" -o "$GBA_FILE" + just gbafix --title "${INTERNAL_NAME:0:12}" --gamecode "${INTERNAL_NAME:0:4}" --makercode GC "$TARGET_FOLDER/thumbv4t-none-eabi/release/$GAME_NAME" -o "$GBA_FILE" cp -v "$GBA_FILE" "examples/target/examples/$GAME_NAME.gba" From f70a280aea632e384071e6b2a3256c0d422ea766 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:18:56 +0100 Subject: [PATCH 24/37] Don't create a dictionary here --- agb-gbafix/Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index a1ac8093..2b4edfc2 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -10,4 +10,4 @@ elf = "0.7" gbafix = "1" bytemuck = "1" anyhow = "1" -clap = { version = "4" } \ No newline at end of file +clap = "4" \ No newline at end of file From 2412ac4dc5d477e204d186b1d9f351a193490771 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:22:02 +0100 Subject: [PATCH 25/37] Add GPL 3.0 licence for gbafix as required by dependencies --- README.md | 4 +- agb-gbafix/LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 677 insertions(+), 1 deletion(-) create mode 100644 agb-gbafix/LICENSE diff --git a/README.md b/README.md index 3a6571f8..b9b06e4e 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,11 @@ agb would not be possible without the help from the following (non-exhaustive) l ## Licence -agb and all its subcrates are released under MPL version 2.0. See full licence +agb and all its subcrates (except agb-gbafix) are released under MPL version 2.0. See full licence text in the `LICENSE` file. +agb-gbafix is released under GPL version 3.0. See the full licence in the agb-gbafix/LICENSE file + agb contains a subset of the code from [agbabi](https://github.com/felixjones/agbabi) which is released under a zlib style licence, details for which you can find under `agb/src/agbabi`. diff --git a/agb-gbafix/LICENSE b/agb-gbafix/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/agb-gbafix/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. From aad5aaf26d5bfffe1fd4a6fca85e56ed0c74831a Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sat, 8 Apr 2023 21:23:37 +0100 Subject: [PATCH 26/37] Remove installation of gbafix --- .github/workflows/build-and-test.yml | 2 -- .github/workflows/publish-agb.yml | 2 -- 2 files changed, 4 deletions(-) diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml index 2e69ef78..f92a6c08 100644 --- a/.github/workflows/build-and-test.yml +++ b/.github/workflows/build-and-test.yml @@ -33,8 +33,6 @@ jobs: run: cargo install --path mgba-test-runner --verbose - name: Set CARGO_TARGET_DIR run: echo "CARGO_TARGET_DIR=$HOME/target" >> $GITHUB_ENV - - name: Install gbafix - run: cargo install gbafix - uses: extractions/setup-just@v1 - name: Setup mdBook uses: peaceiris/actions-mdbook@v1 diff --git a/.github/workflows/publish-agb.yml b/.github/workflows/publish-agb.yml index fdf8254d..5f715f75 100644 --- a/.github/workflows/publish-agb.yml +++ b/.github/workflows/publish-agb.yml @@ -30,8 +30,6 @@ jobs: API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }} run: bash .github/scripts/update-template-repo.sh - - name: Install gbafix - run: cargo install gbafix - name: Build the examples run: just build-roms - name: Upload examples to the release From 1c56de287a42b72ed9e79aa7e49fb0d9470eaa0d Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sun, 9 Apr 2023 18:33:37 +0100 Subject: [PATCH 27/37] Do the padding correctly --- agb-gbafix/src/main.rs | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/agb-gbafix/src/main.rs b/agb-gbafix/src/main.rs index 7fe07200..09a3861a 100644 --- a/agb-gbafix/src/main.rs +++ b/agb-gbafix/src/main.rs @@ -16,7 +16,7 @@ fn main() -> Result<()> { .arg(arg!(-c --gamecode <GAME_CODE> "Sets the game code, 4 bytes")) .arg(arg!(-m --makercode <MAKER_CODE> "Set the maker code, 2 bytes")) .arg(arg!(-r --gameversion <VERSION> "Set the version of the game, 0-255").value_parser(value_parser!(u8))) - .arg(arg!(-p "Ignored for compatibility with gbafix")) + .arg(arg!(-p --padding "Ignored for compatibility with gbafix")) .get_matches(); let input = matches.get_one::<PathBuf>("INPUT").unwrap(); @@ -89,9 +89,7 @@ fn write_gba_file<W: Write>( .section_headers() .ok_or_else(|| anyhow!("Failed to parse as elf file"))?; - const GBA_START_ADDRESS: u64 = 0x8000000; - let mut address = GBA_START_ADDRESS; - + let mut bytes_written = 0; for section_header in section_headers.iter() { const SHT_NOBITS: u32 = 8; const SHT_NULL: u32 = 0; @@ -103,12 +101,12 @@ fn write_gba_file<W: Write>( continue; } - if address < section_header.sh_addr { - for _ in address..section_header.sh_addr { + let align = bytes_written % section_header.sh_addralign; + if align != 0 { + for _ in 0..(section_header.sh_addralign - align) { output.write_all(&[0])?; + bytes_written += 1; } - - address = section_header.sh_addr; } let (mut data, compression) = elf_file.section_data(§ion_header)?; @@ -116,7 +114,7 @@ fn write_gba_file<W: Write>( bail!("Cannot decompress elf content, but got compression header {compression:?}"); } - if address == GBA_START_ADDRESS { + if bytes_written == 0 { const GBA_HEADER_SIZE: usize = 192; ensure!( @@ -131,17 +129,15 @@ fn write_gba_file<W: Write>( output.write_all(header_bytes)?; data = &data[GBA_HEADER_SIZE..]; - address += GBA_HEADER_SIZE as u64; + bytes_written += GBA_HEADER_SIZE as u64; } output.write_all(data)?; - address += data.len() as u64; + bytes_written += data.len() as u64; } - let length = address - GBA_START_ADDRESS; - - if !length.is_power_of_two() { - let required_padding = length.next_power_of_two() - length; + if !bytes_written.is_power_of_two() { + let required_padding = bytes_written.next_power_of_two() - bytes_written; for _ in 0..required_padding { output.write_all(&[0])?; From 8af41a9b3ca3ff8e94d3346b430cabe128c9bf54 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Sun, 9 Apr 2023 18:40:33 +0100 Subject: [PATCH 28/37] Add required fields for publishing --- agb-gbafix/Cargo.toml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index 2b4edfc2..80718f9b 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -2,8 +2,10 @@ name = "agb-gbafix" version = "0.1.0" edition = "2021" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +authors = ["Gwilym Inzani <email@gwilym.dev>"] +license = "GPL-3.0" +description = "CLI utility to convert ELF file to valid GBA ROM" +repository = "https://github.com/agbrs/agb" [dependencies] elf = "0.7" From 0d9cc6c1f79f9c41a0dfd64efd17561519de43b9 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Tue, 11 Apr 2023 20:09:05 +0100 Subject: [PATCH 29/37] Replace references to gbafix with agb-gbafix --- CHANGELOG.md | 3 +++ README.md | 2 -- book/src/setup/building.md | 19 +++++-------------- book/src/setup/linux.md | 4 ++-- book/src/setup/mac.md | 4 ++-- template/README.md | 7 +++---- 6 files changed, 15 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4404d6fd..c15cd3ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added +- Added custom `gbafix` implementation which can take the elf file produced by `cargo build` directly, removing the need for the objcopy step. + ### Changed - Made Vector2D::new a const function. - The template now uses rust 2021 edition by default. diff --git a/README.md b/README.md index b9b06e4e..ed82fb7b 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,6 @@ to just write games for the Game Boy Advance using this library: * Install with `cargo install just` * [mdbook](https://rust-lang.github.io/mdBook/index.html) * Install with `cargo install mdbook` -* [gbafix](https://crates.io/crates/gbafix) - * Install with `cargo install gbafix` With all of this installed, you should be able to run a full build of agb using by running ```sh diff --git a/book/src/setup/building.md b/book/src/setup/building.md index 0358c76e..d88b9e53 100644 --- a/book/src/setup/building.md +++ b/book/src/setup/building.md @@ -30,30 +30,21 @@ Depending on your platform, the file will have either a `.elf` extension or no e ## 3. Convert the binary to a GBA file In order to run the game on an emulator, we need to convert the binary file to a GBA file. -To do this, we'll use two tools: `arm-none-eabi-objcopy` and `gbafix`. +To do this, we'll use the tool `agb-gbafix`. -Run the following command to convert the binary file to a GBA file: +Run the following command to convert the binary file to a GBA ROM: ```sh -arm-none-eabi-objcopy -O binary target/thumbv4t-none-eabi/release/template template.gba +agb-gbafix target/thumbv4t-none-eabi/release/template -o template.gba ``` or ```sh -arm-none-eabi-objcopy -O binary target/thumbv4t-none-eabi/release/template.elf template.gba +agb-gbafix target/thumbv4t-none-eabi/release/template.elf -o template.gba ``` -Depending on whether your file has the .elf extension. -This command will create a template.gba file in the template directory. - -Next, run the following command to fix the GBA header: - -```sh -gbafix template.gba -``` - -This command will add the correct GBA header to the template.gba file. +This command will add the correct GBA header to the template.gba file and it will be playable on real hardware or an emulator. ## 4. Run the game diff --git a/book/src/setup/linux.md b/book/src/setup/linux.md index 0c4c6574..f96557f0 100644 --- a/book/src/setup/linux.md +++ b/book/src/setup/linux.md @@ -25,8 +25,8 @@ The source code for the game is hosted on github, so you will need to install gi # 4. gbafix -In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'gbafix'. -The rust implementation can be installed very easily using `cargo install gbafix`. +In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'agb-gbafix'. +Agb's implementation can be installed very easily using `cargo install agb-gbafix`. Make sure that the Cargo bin directory is in your `PATH` as we'll need to use it later. diff --git a/book/src/setup/mac.md b/book/src/setup/mac.md index a03248ca..510765e3 100644 --- a/book/src/setup/mac.md +++ b/book/src/setup/mac.md @@ -43,8 +43,8 @@ After installing to your `/Applications` folder you can add the binary to your p # 5. Real hardware - gbafix -In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'gbafix'. -The rust implementation can be installed very easily using `cargo install gbafix`. +In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'agb-gbafix'. +Agb's implementation can be installed very easily using `cargo install agb-gbafix`. Make sure that the Cargo bin directory is in your `PATH` as we'll need to use it later. diff --git a/template/README.md b/template/README.md index 423ea1e4..2d488275 100644 --- a/template/README.md +++ b/template/README.md @@ -22,8 +22,8 @@ You will also want to install an emulator. The best support in agb is with [mgba `println!` support via `agb::println!` but any emulator should work. You'll get the best experience if `mgba-qt` is in your `PATH`. -If you want to run your game on real hardware, you will also need to install `gbafix` which you can do after installing -rust with the following: `cargo install gbafix`. This is not required if you are only running your game in an emulator. +If you want to run your game on real hardware, you will also need to install `agb-gbafix` which you can do after installing +rust with the following: `cargo install agb-gbafix`. This is not required if you are only running your game in an emulator. ### Running in an emulator @@ -68,6 +68,5 @@ running on the real thing. First build the binary in release mode using the instructions above, then do the following: ```sh -arm-none-eabi-objcopy -O binary target/thumbv4t-none-eabi/release/<your game> <your game>.gba -gbafix <your game>.gba +agb-gbafix target/thumbv4t-none-eabi/release/<your game> -o <your game>.gba ``` \ No newline at end of file From aea64e974fdf6f725a472b56379ff744690b1350 Mon Sep 17 00:00:00 2001 From: Corwin <corwin@kuiper.dev> Date: Tue, 11 Apr 2023 20:59:45 +0100 Subject: [PATCH 30/37] change of language --- agb/src/interrupt.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agb/src/interrupt.rs b/agb/src/interrupt.rs index dda401fc..6cb8593d 100644 --- a/agb/src/interrupt.rs +++ b/agb/src/interrupt.rs @@ -231,7 +231,7 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot { /// - Many functions in agb allocate and it isn't always clear. /// /// # Staticness -/// * The closure must be static because forgetting the interrupt handler will +/// * The closure must be static because forgetting the interrupt handler would /// cause a use after free. /// /// [`CriticalSection`]: bare_metal::CriticalSection From fd79611dc35f76ad4dedbe400899b2b345d4b39c Mon Sep 17 00:00:00 2001 From: Corwin <corwin@kuiper.dev> Date: Tue, 11 Apr 2023 21:27:09 +0100 Subject: [PATCH 31/37] update lock files --- book/games/pong/Cargo.lock | 71 +++++++++++++++++++++++++++++++++++-- examples/combo/Cargo.lock | 72 +++++++++++++++++++++++++++++++++++--- 2 files changed, 136 insertions(+), 7 deletions(-) diff --git a/book/games/pong/Cargo.lock b/book/games/pong/Cargo.lock index 16d18409..7ee79661 100644 --- a/book/games/pong/Cargo.lock +++ b/book/games/pong/Cargo.lock @@ -176,7 +176,7 @@ version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6a62391ecb864cf12ed06b2af4eda2e609b97657950d6a8f06841b17726ab253" dependencies = [ - "hashbrown", + "hashbrown 0.11.2", "ttf-parser", ] @@ -200,6 +200,12 @@ dependencies = [ "ahash", ] +[[package]] +name = "hashbrown" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" + [[package]] name = "hound" version = "3.5.0" @@ -221,6 +227,16 @@ dependencies = [ "png", ] +[[package]] +name = "indexmap" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99" +dependencies = [ + "autocfg", + "hashbrown 0.12.3", +] + [[package]] name = "libc" version = "0.2.140" @@ -236,6 +252,12 @@ dependencies = [ "cfg-if", ] +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + [[package]] name = "miniz_oxide" version = "0.3.7" @@ -391,6 +413,15 @@ dependencies = [ "syn 2.0.8", ] +[[package]] +name = "serde_spanned" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0efd8caf556a6cebd3b285caf480045fcc1ac04f6bd786b09a6f11af30c4fcf4" +dependencies = [ + "serde", +] + [[package]] name = "static_assertions" version = "1.1.0" @@ -421,11 +452,36 @@ dependencies = [ [[package]] name = "toml" -version = "0.5.11" +version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f4f7f0dd8d50a853a531c426359045b1998f04219d88799810762cd4ad314234" +checksum = "b403acf6f2bb0859c93c7f0d967cb4a75a7ac552100f9322faf64dc047669b21" dependencies = [ "serde", + "serde_spanned", + "toml_datetime", + "toml_edit", +] + +[[package]] +name = "toml_datetime" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ab8ed2edee10b50132aed5f331333428b011c99402b5a534154ed15746f9622" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_edit" +version = "0.19.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "239410c8609e8125456927e6707163a3b1fdb40561e4b803bc041f466ccfdc13" +dependencies = [ + "indexmap", + "serde", + "serde_spanned", + "toml_datetime", + "winnow", ] [[package]] @@ -451,3 +507,12 @@ name = "wasi" version = "0.11.0+wasi-snapshot-preview1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[package]] +name = "winnow" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae8970b36c66498d8ff1d66685dc86b91b29db0c7739899012f63a63814b4b28" +dependencies = [ + "memchr", +] diff --git a/examples/combo/Cargo.lock b/examples/combo/Cargo.lock index 68bc03c2..2ee9eb39 100644 --- a/examples/combo/Cargo.lock +++ b/examples/combo/Cargo.lock @@ -201,7 +201,7 @@ version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6a62391ecb864cf12ed06b2af4eda2e609b97657950d6a8f06841b17726ab253" dependencies = [ - "hashbrown", + "hashbrown 0.11.2", "ttf-parser", ] @@ -234,6 +234,12 @@ dependencies = [ "ahash", ] +[[package]] +name = "hashbrown" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" + [[package]] name = "hound" version = "3.5.0" @@ -245,7 +251,6 @@ name = "hyperspace-roll" version = "0.1.0" dependencies = [ "agb", - "bare-metal", ] [[package]] @@ -263,6 +268,16 @@ dependencies = [ "png", ] +[[package]] +name = "indexmap" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99" +dependencies = [ + "autocfg", + "hashbrown 0.12.3", +] + [[package]] name = "itoa" version = "1.0.6" @@ -296,6 +311,12 @@ dependencies = [ "cfg-if 1.0.0", ] +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + [[package]] name = "miniz_oxide" version = "0.3.7" @@ -467,6 +488,15 @@ dependencies = [ "serde", ] +[[package]] +name = "serde_spanned" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0efd8caf556a6cebd3b285caf480045fcc1ac04f6bd786b09a6f11af30c4fcf4" +dependencies = [ + "serde", +] + [[package]] name = "static_assertions" version = "1.1.0" @@ -533,11 +563,36 @@ dependencies = [ [[package]] name = "toml" -version = "0.5.11" +version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f4f7f0dd8d50a853a531c426359045b1998f04219d88799810762cd4ad314234" +checksum = "b403acf6f2bb0859c93c7f0d967cb4a75a7ac552100f9322faf64dc047669b21" dependencies = [ "serde", + "serde_spanned", + "toml_datetime", + "toml_edit", +] + +[[package]] +name = "toml_datetime" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ab8ed2edee10b50132aed5f331333428b011c99402b5a534154ed15746f9622" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_edit" +version = "0.19.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "239410c8609e8125456927e6707163a3b1fdb40561e4b803bc041f466ccfdc13" +dependencies = [ + "indexmap", + "serde", + "serde_spanned", + "toml_datetime", + "winnow", ] [[package]] @@ -564,6 +619,15 @@ version = "0.11.0+wasi-snapshot-preview1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" +[[package]] +name = "winnow" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae8970b36c66498d8ff1d66685dc86b91b29db0c7739899012f63a63814b4b28" +dependencies = [ + "memchr", +] + [[package]] name = "xml-rs" version = "0.8.4" From fc5ce97db4068fa8aa3e07d3a594afda4c913ddf Mon Sep 17 00:00:00 2001 From: Corwin <corwin@kuiper.dev> Date: Tue, 11 Apr 2023 21:28:22 +0100 Subject: [PATCH 32/37] Release v0.14.0 --- CHANGELOG.md | 2 ++ agb-fixnum/Cargo.toml | 4 ++-- agb-gbafix/Cargo.lock | 2 +- agb-gbafix/Cargo.toml | 4 ++-- agb-image-converter/Cargo.toml | 2 +- agb-macros/Cargo.toml | 2 +- agb-sound-converter/Cargo.toml | 2 +- agb/Cargo.toml | 10 +++++----- book/games/pong/Cargo.lock | 10 +++++----- book/games/pong/Cargo.toml | 2 +- examples/combo/Cargo.lock | 10 +++++----- examples/combo/Cargo.toml | 2 +- examples/hyperspace-roll/Cargo.lock | 10 +++++----- examples/hyperspace-roll/Cargo.toml | 2 +- examples/the-hat-chooses-the-wizard/Cargo.lock | 10 +++++----- examples/the-hat-chooses-the-wizard/Cargo.toml | 2 +- examples/the-purple-night/Cargo.lock | 10 +++++----- examples/the-purple-night/Cargo.toml | 2 +- template/Cargo.toml | 2 +- 19 files changed, 46 insertions(+), 44 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 841c6936..7c1024e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.14.0] - 2023/04/11 + ### Added - Added custom `gbafix` implementation which can take the elf file produced by `cargo build` directly, removing the need for the objcopy step. diff --git a/agb-fixnum/Cargo.toml b/agb-fixnum/Cargo.toml index 2b97d8c4..cb4e16ef 100644 --- a/agb-fixnum/Cargo.toml +++ b/agb-fixnum/Cargo.toml @@ -1,10 +1,10 @@ [package] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" edition = "2021" license = "MPL-2.0" description = "Library for abstracting over fixed precision numbers. Designed for use with the agb library for the Game Boy Advance" repository = "https://github.com/agbrs/agb" [dependencies] -agb_macros = { version = "0.13.0", path = "../agb-macros" } +agb_macros = { version = "0.14.0", path = "../agb-macros" } diff --git a/agb-gbafix/Cargo.lock b/agb-gbafix/Cargo.lock index 3bed8d81..7bee57fa 100644 --- a/agb-gbafix/Cargo.lock +++ b/agb-gbafix/Cargo.lock @@ -4,7 +4,7 @@ version = 3 [[package]] name = "agb-gbafix" -version = "0.1.0" +version = "0.14.0" dependencies = [ "anyhow", "bytemuck", diff --git a/agb-gbafix/Cargo.toml b/agb-gbafix/Cargo.toml index 80718f9b..71f85fbc 100644 --- a/agb-gbafix/Cargo.toml +++ b/agb-gbafix/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "agb-gbafix" -version = "0.1.0" +version = "0.14.0" edition = "2021" authors = ["Gwilym Inzani <email@gwilym.dev>"] license = "GPL-3.0" @@ -12,4 +12,4 @@ elf = "0.7" gbafix = "1" bytemuck = "1" anyhow = "1" -clap = "4" \ No newline at end of file +clap = "4" diff --git a/agb-image-converter/Cargo.toml b/agb-image-converter/Cargo.toml index 035b2ab9..d787fcc2 100644 --- a/agb-image-converter/Cargo.toml +++ b/agb-image-converter/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" authors = ["Gwilym Kuiper <gw@ilym.me>"] edition = "2021" license = "MPL-2.0" diff --git a/agb-macros/Cargo.toml b/agb-macros/Cargo.toml index bb2556a4..64184680 100644 --- a/agb-macros/Cargo.toml +++ b/agb-macros/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" authors = ["Gwilym Kuiper <gw@ilym.me>"] edition = "2021" license = "MPL-2.0" diff --git a/agb-sound-converter/Cargo.toml b/agb-sound-converter/Cargo.toml index 997f0755..4ac5bc29 100644 --- a/agb-sound-converter/Cargo.toml +++ b/agb-sound-converter/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" authors = ["Gwilym Kuiper <gw@ilym.me>"] edition = "2021" license = "MPL-2.0" diff --git a/agb/Cargo.toml b/agb/Cargo.toml index 02cdc17b..583033a5 100644 --- a/agb/Cargo.toml +++ b/agb/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "agb" -version = "0.13.0" +version = "0.14.0" authors = ["Corwin Kuiper <corwin@kuiper.dev>", "Gwilym Kuiper <gw@ilym.me>"] edition = "2021" description = "Library for Game Boy Advance Development" @@ -23,10 +23,10 @@ testing = [] [dependencies] bitflags = "2" -agb_image_converter = { version = "0.13.0", path = "../agb-image-converter" } -agb_sound_converter = { version = "0.13.0", path = "../agb-sound-converter" } -agb_macros = { version = "0.13.0", path = "../agb-macros" } -agb_fixnum = { version = "0.13.0", path = "../agb-fixnum" } +agb_image_converter = { version = "0.14.0", path = "../agb-image-converter" } +agb_sound_converter = { version = "0.14.0", path = "../agb-sound-converter" } +agb_macros = { version = "0.14.0", path = "../agb-macros" } +agb_fixnum = { version = "0.14.0", path = "../agb-fixnum" } bare-metal = "1" modular-bitfield = "0.11" rustc-hash = { version = "1", default-features = false } diff --git a/book/games/pong/Cargo.lock b/book/games/pong/Cargo.lock index 7ee79661..5915f0ec 100644 --- a/book/games/pong/Cargo.lock +++ b/book/games/pong/Cargo.lock @@ -16,7 +16,7 @@ checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234" [[package]] name = "agb" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_fixnum", "agb_image_converter", @@ -30,14 +30,14 @@ dependencies = [ [[package]] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_macros", ] [[package]] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "asefile", "fontdue", @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" dependencies = [ "proc-macro2", "quote", @@ -60,7 +60,7 @@ dependencies = [ [[package]] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "hound", "proc-macro2", diff --git a/book/games/pong/Cargo.toml b/book/games/pong/Cargo.toml index c13ae22b..ec83e037 100644 --- a/book/games/pong/Cargo.toml +++ b/book/games/pong/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = { version = "0.13.0", path = "../../../agb" } +agb = { version = "0.14.0", path = "../../../agb" } [profile.dev] opt-level = 2 diff --git a/examples/combo/Cargo.lock b/examples/combo/Cargo.lock index 2ee9eb39..0d0332fc 100644 --- a/examples/combo/Cargo.lock +++ b/examples/combo/Cargo.lock @@ -16,7 +16,7 @@ checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234" [[package]] name = "agb" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_fixnum", "agb_image_converter", @@ -30,14 +30,14 @@ dependencies = [ [[package]] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_macros", ] [[package]] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "asefile", "fontdue", @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" dependencies = [ "proc-macro2", "quote", @@ -60,7 +60,7 @@ dependencies = [ [[package]] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "hound", "proc-macro2", diff --git a/examples/combo/Cargo.toml b/examples/combo/Cargo.toml index 519934c3..d27c394e 100644 --- a/examples/combo/Cargo.toml +++ b/examples/combo/Cargo.toml @@ -6,7 +6,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = { version = "0.13.0", path = "../../agb" } +agb = { version = "0.14.0", path = "../../agb" } the-purple-night = { path = "../the-purple-night" } the-hat-chooses-the-wizard = { path = "../the-hat-chooses-the-wizard" } hyperspace-roll = { path = "../hyperspace-roll" } diff --git a/examples/hyperspace-roll/Cargo.lock b/examples/hyperspace-roll/Cargo.lock index da95b861..b0461ff4 100644 --- a/examples/hyperspace-roll/Cargo.lock +++ b/examples/hyperspace-roll/Cargo.lock @@ -16,7 +16,7 @@ checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234" [[package]] name = "agb" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_fixnum", "agb_image_converter", @@ -30,14 +30,14 @@ dependencies = [ [[package]] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_macros", ] [[package]] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "asefile", "fontdue", @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" dependencies = [ "proc-macro2", "quote", @@ -60,7 +60,7 @@ dependencies = [ [[package]] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "hound", "proc-macro2", diff --git a/examples/hyperspace-roll/Cargo.toml b/examples/hyperspace-roll/Cargo.toml index 0422fa8b..1e8cdd9d 100644 --- a/examples/hyperspace-roll/Cargo.toml +++ b/examples/hyperspace-roll/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = { version = "0.13.0", path = "../../agb" } +agb = { version = "0.14.0", path = "../../agb" } [profile.dev] opt-level = 2 diff --git a/examples/the-hat-chooses-the-wizard/Cargo.lock b/examples/the-hat-chooses-the-wizard/Cargo.lock index 44a85826..3bdb1ec3 100644 --- a/examples/the-hat-chooses-the-wizard/Cargo.lock +++ b/examples/the-hat-chooses-the-wizard/Cargo.lock @@ -16,7 +16,7 @@ checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234" [[package]] name = "agb" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_fixnum", "agb_image_converter", @@ -30,14 +30,14 @@ dependencies = [ [[package]] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_macros", ] [[package]] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "asefile", "fontdue", @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" dependencies = [ "proc-macro2", "quote", @@ -60,7 +60,7 @@ dependencies = [ [[package]] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "hound", "proc-macro2", diff --git a/examples/the-hat-chooses-the-wizard/Cargo.toml b/examples/the-hat-chooses-the-wizard/Cargo.toml index 3fd5fc07..9af5d5fb 100644 --- a/examples/the-hat-chooses-the-wizard/Cargo.toml +++ b/examples/the-hat-chooses-the-wizard/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = { version = "0.13.0", path = "../../agb" } +agb = { version = "0.14.0", path = "../../agb" } [build-dependencies] serde = { version = "1.0", features = ["derive"] } diff --git a/examples/the-purple-night/Cargo.lock b/examples/the-purple-night/Cargo.lock index 47cd52a5..ac89ff17 100644 --- a/examples/the-purple-night/Cargo.lock +++ b/examples/the-purple-night/Cargo.lock @@ -16,7 +16,7 @@ checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234" [[package]] name = "agb" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_fixnum", "agb_image_converter", @@ -30,14 +30,14 @@ dependencies = [ [[package]] name = "agb_fixnum" -version = "0.13.0" +version = "0.14.0" dependencies = [ "agb_macros", ] [[package]] name = "agb_image_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "asefile", "fontdue", @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "agb_macros" -version = "0.13.0" +version = "0.14.0" dependencies = [ "proc-macro2", "quote", @@ -60,7 +60,7 @@ dependencies = [ [[package]] name = "agb_sound_converter" -version = "0.13.0" +version = "0.14.0" dependencies = [ "hound", "proc-macro2", diff --git a/examples/the-purple-night/Cargo.toml b/examples/the-purple-night/Cargo.toml index 82284aba..7c6daae6 100644 --- a/examples/the-purple-night/Cargo.toml +++ b/examples/the-purple-night/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = { path = "../../agb", version = "0.13.0" } +agb = { path = "../../agb", version = "0.14.0" } generational-arena = { version = "0.2", default-features = false } [build-dependencies] diff --git a/template/Cargo.toml b/template/Cargo.toml index 266cf916..29bc4d85 100644 --- a/template/Cargo.toml +++ b/template/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -agb = "0.13.0" +agb = "0.14.0" [profile.dev] opt-level = 2 From 70979fc7da247b46553d01d911268447f986e396 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Tue, 11 Apr 2023 21:54:48 +0100 Subject: [PATCH 33/37] Publish gbafix --- tools/src/publish.rs | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/tools/src/publish.rs b/tools/src/publish.rs index da637e1e..1a352332 100644 --- a/tools/src/publish.rs +++ b/tools/src/publish.rs @@ -39,7 +39,9 @@ pub fn publish(matches: &ArgMatches) -> Result<(), Error> { let mut published_crates: HashSet<String> = HashSet::new(); let dependencies = build_dependency_graph(&root_directory)?; - let crates_to_publish: Vec<_> = dependencies.keys().collect(); + let mut crates_to_publish: Vec<_> = dependencies.keys().collect(); + let agb_gbafix = "agb-gbafix".to_owned(); + crates_to_publish.push(&agb_gbafix); while published_crates.len() != crates_to_publish.len() { // find all crates which can be published now but haven't @@ -47,10 +49,13 @@ pub fn publish(matches: &ArgMatches) -> Result<(), Error> { .iter() .filter(|&&crate_to_publish| !published_crates.contains(crate_to_publish)) .filter(|&&crate_to_publish| { - let dependencies_of_crate = &dependencies[crate_to_publish]; - for dependency_of_crate in dependencies_of_crate { - if !fully_published_crates.contains(dependency_of_crate) { - return false; + let dependencies_of_crate = &dependencies.get(crate_to_publish); + + if let Some(dependencies_of_crate) = dependencies_of_crate { + for dependency_of_crate in *dependencies_of_crate { + if !fully_published_crates.contains(dependency_of_crate) { + return false; + } } } From 63995995ac740f02c12206144d3532c96a65b4a6 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Tue, 11 Apr 2023 22:29:23 +0100 Subject: [PATCH 34/37] Make publishing a bit smarter --- tools/Cargo.lock | 26 +++++++ tools/Cargo.toml | 1 + tools/src/publish.rs | 172 +++++++++++++++++++------------------------ 3 files changed, 101 insertions(+), 98 deletions(-) diff --git a/tools/Cargo.lock b/tools/Cargo.lock index a2508c2c..6c804fdc 100644 --- a/tools/Cargo.lock +++ b/tools/Cargo.lock @@ -138,6 +138,15 @@ dependencies = [ "syn 2.0.8", ] +[[package]] +name = "dependency-graph" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5143247629540606d0888beae9ca0e0b9a81a32151bfecd0b2be4a961155c24d" +dependencies = [ + "petgraph", +] + [[package]] name = "errno" version = "0.2.8" @@ -159,6 +168,12 @@ dependencies = [ "libc", ] +[[package]] +name = "fixedbitset" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ce7134b9999ecaf8bcd65542e436736ef32ddca1b3e06094cb6ec5755203b80" + [[package]] name = "glob" version = "0.3.1" @@ -310,6 +325,16 @@ version = "6.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ceedf44fb00f2d1984b0bc98102627ce622e083e49a5bacdb3e514fa4238e267" +[[package]] +name = "petgraph" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dd7d28ee937e54fe3080c91faa1c3a46c06de6252988a7f4592ba2310ef22a4" +dependencies = [ + "fixedbitset", + "indexmap", +] + [[package]] name = "proc-macro2" version = "1.0.53" @@ -419,6 +444,7 @@ version = "0.1.0" dependencies = [ "chrono", "clap", + "dependency-graph", "glob", "toml_edit", ] diff --git a/tools/Cargo.toml b/tools/Cargo.toml index 8c1095ac..30f662e6 100644 --- a/tools/Cargo.toml +++ b/tools/Cargo.toml @@ -10,3 +10,4 @@ clap = "4" toml_edit = "0.19" glob = "0.3" chrono = "0.4" +dependency-graph = "0.1.5" diff --git a/tools/src/publish.rs b/tools/src/publish.rs index 1a352332..8bbe20c7 100644 --- a/tools/src/publish.rs +++ b/tools/src/publish.rs @@ -1,10 +1,11 @@ use clap::{Arg, ArgAction, ArgMatches}; -use std::collections::{HashMap, HashSet}; +use dependency_graph::DependencyGraph; +use std::borrow::BorrowMut; +use std::cell::RefCell; +use std::collections::HashMap; use std::fs; use std::path::Path; use std::process::Command; -use std::thread; -use std::time::Duration; use toml_edit::Document; use crate::utils::*; @@ -19,6 +20,23 @@ pub enum Error { CargoToml, } +struct Package { + name: String, + dependencies: Vec<String>, +} + +impl dependency_graph::Node for Package { + type DependencyType = String; + + fn dependencies(&self) -> &[Self::DependencyType] { + &self.dependencies + } + + fn matches(&self, dependency: &Self::DependencyType) -> bool { + &self.name == dependency + } +} + pub fn command() -> clap::Command { clap::Command::new("publish") .about("Publishes agb and all subcrates") @@ -32,96 +50,51 @@ pub fn command() -> clap::Command { pub fn publish(matches: &ArgMatches) -> Result<(), Error> { let dry_run = matches.get_one::<bool>("Dry run").expect("defined by clap"); + let dry_run = if *dry_run { vec!["--dry-run"] } else { vec![] }; let root_directory = find_agb_root_directory().map_err(|_| Error::FindRootDirectory)?; - let mut fully_published_crates: HashSet<String> = HashSet::new(); - let mut published_crates: HashSet<String> = HashSet::new(); + let mut in_progress: HashMap<_, RefCell<std::process::Child>> = HashMap::new(); let dependencies = build_dependency_graph(&root_directory)?; - let mut crates_to_publish: Vec<_> = dependencies.keys().collect(); - let agb_gbafix = "agb-gbafix".to_owned(); - crates_to_publish.push(&agb_gbafix); + let graph = DependencyGraph::from(&dependencies[..]); - while published_crates.len() != crates_to_publish.len() { - // find all crates which can be published now but haven't - let publishable_crates: Vec<_> = crates_to_publish - .iter() - .filter(|&&crate_to_publish| !published_crates.contains(crate_to_publish)) - .filter(|&&crate_to_publish| { - let dependencies_of_crate = &dependencies.get(crate_to_publish); + for package in graph { + let package = package.as_resolved().unwrap(); - if let Some(dependencies_of_crate) = dependencies_of_crate { - for dependency_of_crate in *dependencies_of_crate { - if !fully_published_crates.contains(dependency_of_crate) { - return false; - } - } - } - - true - }) - .collect(); - - for publishable_crate in publishable_crates { - if *dry_run { - println!("Would execute cargo publish for {publishable_crate}"); - } else { - assert!(Command::new("cargo") - .arg("publish") - .current_dir(&root_directory.join(publishable_crate)) - .status() - .map_err(|_| Error::PublishCrate)? - .success()); - } - - published_crates.insert(publishable_crate.to_string()); + for dep in &package.dependencies { + assert!(in_progress + .get(dep) + .unwrap() + .borrow_mut() + .wait() + .map_err(|_| Error::PublishCrate)? + .success()); } - for published_crate in published_crates.iter() { - if !fully_published_crates.contains(published_crate) { - let expected_version = - read_cargo_toml_version(&root_directory.join(published_crate))?; - if check_if_released(published_crate, &expected_version)? { - fully_published_crates.insert(published_crate.clone()); - } - } - } + println!("Publishing {}", package.name); - thread::sleep(Duration::from_secs(10)); + let publish_cmd = Command::new("cargo") + .arg("publish") + .args(&dry_run) + .current_dir(root_directory.join(&package.name)) + .spawn() + .map_err(|_| Error::PublishCrate)?; + + in_progress.insert(package.name.clone(), RefCell::new(publish_cmd)); + } + + for (_, in_progress) in in_progress { + assert!(in_progress + .borrow_mut() + .wait() + .map_err(|_| Error::PublishCrate)? + .success()); } Ok(()) } -fn check_if_released(crate_to_publish: &str, expected_version: &str) -> Result<bool, Error> { - let url_to_poll = &get_url_to_poll(crate_to_publish); - - println!("Polling crates.io with URL {url_to_poll} for {crate_to_publish} hoping for version {expected_version}."); - - let curl_result = Command::new("curl") - .arg(url_to_poll) - .output() - .map_err(|_| Error::Poll)?; - - Ok(String::from_utf8_lossy(&curl_result.stdout).contains(expected_version)) -} - -fn get_url_to_poll(crate_name: &str) -> String { - let crate_name_with_underscores = crate_name.replace('-', "_"); - - let crate_folder = if crate_name_with_underscores.len() == 3 { - format!("3/{}", crate_name_with_underscores.chars().next().unwrap()) - } else { - let first_two_characters = &crate_name_with_underscores[0..2]; - let second_two_characters = &crate_name_with_underscores[2..4]; - - format!("{first_two_characters}/{second_two_characters}") - }; - - format!("https://raw.githubusercontent.com/rust-lang/crates.io-index/master/{crate_folder}/{crate_name_with_underscores}") -} - fn read_cargo_toml_version(folder: &Path) -> Result<String, Error> { let cargo_toml = read_cargo_toml(folder)?; @@ -134,30 +107,33 @@ fn read_cargo_toml_version(folder: &Path) -> Result<String, Error> { Ok(version_value.to_owned()) } -fn build_dependency_graph(root: &Path) -> Result<HashMap<String, Vec<String>>, Error> { - let mut result = HashMap::new(); - result.insert("agb".to_owned(), get_agb_dependencies(&root.join("agb"))?); +fn build_dependency_graph(root: &Path) -> Result<Vec<Package>, Error> { + let dirs = fs::read_dir(root).map_err(|_| Error::ReadingDependencies)?; + let mut packages = vec![]; - let mut added_new_crates = true; - while added_new_crates { - added_new_crates = false; - - let all_crates: HashSet<String> = HashSet::from_iter(result.values().flatten().cloned()); - - for dep_crate in all_crates { - if result.contains_key(&dep_crate) { - continue; - } - - added_new_crates = true; - result.insert( - dep_crate.to_owned(), - get_agb_dependencies(&root.join(dep_crate))?, - ); + for dir in dirs { + let dir = dir.map_err(|_| Error::ReadingDependencies)?; + if !dir + .file_type() + .map_err(|_| Error::ReadingDependencies)? + .is_dir() + { + continue; } + + if !dir.file_name().to_string_lossy().starts_with("agb") { + continue; + } + + let crate_path = root.join(dir.path()); + + packages.push(Package { + name: dir.file_name().to_string_lossy().to_string(), + dependencies: get_agb_dependencies(&crate_path)?, + }); } - Ok(result) + Ok(packages) } fn get_agb_dependencies(folder: &Path) -> Result<Vec<String>, Error> { From f677ff1840b93f0679b7a967d4a8dbc317b23aa8 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Tue, 11 Apr 2023 22:30:47 +0100 Subject: [PATCH 35/37] Fix clippy lints --- tools/src/publish.rs | 41 ----------------------------------------- 1 file changed, 41 deletions(-) diff --git a/tools/src/publish.rs b/tools/src/publish.rs index 8bbe20c7..be68209f 100644 --- a/tools/src/publish.rs +++ b/tools/src/publish.rs @@ -1,6 +1,5 @@ use clap::{Arg, ArgAction, ArgMatches}; use dependency_graph::DependencyGraph; -use std::borrow::BorrowMut; use std::cell::RefCell; use std::collections::HashMap; use std::fs; @@ -95,18 +94,6 @@ pub fn publish(matches: &ArgMatches) -> Result<(), Error> { Ok(()) } -fn read_cargo_toml_version(folder: &Path) -> Result<String, Error> { - let cargo_toml = read_cargo_toml(folder)?; - - let version_value = cargo_toml["package"]["version"] - .as_value() - .ok_or(Error::CrateVersion)? - .as_str() - .ok_or(Error::CrateVersion)?; - - Ok(version_value.to_owned()) -} - fn build_dependency_graph(root: &Path) -> Result<Vec<Package>, Error> { let dirs = fs::read_dir(root).map_err(|_| Error::ReadingDependencies)?; let mut packages = vec![]; @@ -172,34 +159,6 @@ mod test { command().debug_assert(); } - #[test] - fn url_to_poll_should_return_correct_url() { - let test_cases = [ - ["agb", "3/a/agb"], - ["agb-image-converter", "ag/b_/agb_image_converter"], - ["agb-fixnum", "ag/b_/agb_fixnum"], - ]; - - for [name, result] in test_cases { - let url = get_url_to_poll(name); - assert_eq!( - url, - format!( - "https://raw.githubusercontent.com/rust-lang/crates.io-index/master/{result}", - ) - ) - } - } - - #[test] - fn should_read_version() -> Result<(), Error> { - let root_directory = crate::utils::find_agb_root_directory().unwrap(); - let my_version = read_cargo_toml_version(&root_directory.join("tools"))?; - - assert_eq!(my_version, "0.1.0"); - Ok(()) - } - #[test] fn should_detect_dependencies() -> Result<(), Error> { let root_directory = crate::utils::find_agb_root_directory().unwrap(); From 5f59a01c21f7e55999e6b43fed8f391c536a8e23 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Wed, 12 Apr 2023 13:49:22 +0100 Subject: [PATCH 36/37] Use .take() rather than replace(..., None) --- agb/src/single.rs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/agb/src/single.rs b/agb/src/single.rs index 2d6e11d4..0215ab63 100644 --- a/agb/src/single.rs +++ b/agb/src/single.rs @@ -11,7 +11,6 @@ impl<T> Singleton<T> { Singleton { single: None } } pub fn take(&mut self) -> T { - let g = core::mem::replace(&mut self.single, None); - g.unwrap() + self.single.take().unwrap() } } From 0e006bd3d5795783be3e4335c35b04cd0a235ae5 Mon Sep 17 00:00:00 2001 From: Gwilym Inzani <gw@ilym.me> Date: Wed, 12 Apr 2023 15:12:00 +0100 Subject: [PATCH 37/37] Update publish justfile command to accept arguments --- justfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/justfile b/justfile index 032849cb..4a0b9e7d 100644 --- a/justfile +++ b/justfile @@ -81,7 +81,7 @@ update-linker-scripts: find -type f -name gba.ld | grep -v ./agb/gba.ld | xargs -n1 cp -v -- agb/gba.ld find -type f -name gba_mb.ld | grep -v ./agb/gba_mb.ld | xargs -n1 cp -v -- agb/gba_mb.ld -publish: (_run-tool "publish") +publish *args: (_run-tool "publish" args) release +args: (_run-tool "release" args)