Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New StaticMemoryInitializer type #38

Merged
merged 1 commit into from
Dec 18, 2023
Merged

New StaticMemoryInitializer type #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion execution-plan/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use std::fmt;
use api_endpoint::ApiEndpoint;
use kittycad_modeling_cmds::{each_cmd, id::ModelingCmdId};
use kittycad_modeling_session::{RunCommandError, Session as ModelingSession};
use memory::Memory;
pub use memory::{Memory, StaticMemoryInitializer};
use serde::{Deserialize, Serialize};

use self::{arithmetic::Arithmetic, primitive::Primitive};
Expand All @@ -28,6 +28,14 @@ mod value;
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub struct Address(usize);

impl Address {
/// Offset the memory by `size` addresses.
pub fn offset(self, size: usize) -> Self {
let curr = self.0;
Self(curr + size)
}
}

impl fmt::Display for Address {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
Expand Down
33 changes: 33 additions & 0 deletions execution-plan/src/memory.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
use super::Result;
use crate::{primitive::Primitive, value::Value, Address};

/// Helper wrapper around Memory. It lets you push static data into memory before the program runs.
pub struct StaticMemoryInitializer {
memory: Memory,
last: Address,
}

impl Default for StaticMemoryInitializer {
fn default() -> Self {
Self {
memory: Default::default(),
last: Address(0),
}
}
}

impl StaticMemoryInitializer {
/// Finish putting static data into memory, get ready to execute the plan.
/// Returns normal execution plan program memory.
pub fn finish(self) -> Memory {
self.memory
}

/// Put the next value into memory.
/// Returns the address that the value was inserted at.
pub fn push<T: Value>(&mut self, val: T) -> Address {
let addr_of_value = self.last;
let len = self.memory.set_composite(self.last, val);
self.last = self.last.offset(len);
addr_of_value
}
}

/// KCEP's program memory. A flat, linear list of values.
#[derive(Debug)]
#[cfg_attr(test, derive(PartialEq))]
Expand Down Expand Up @@ -51,6 +83,7 @@ impl Memory {
T::from_parts(&mut values)
}

/// Iterate over each memory address and its value.
pub fn iter(&self) -> impl Iterator<Item = (usize, &Option<Primitive>)> {
self.addresses.iter().enumerate()
}
Expand Down
46 changes: 23 additions & 23 deletions execution-plan/src/snapshots/kittycad_execution_plan__tests__cube_memory_after.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,32 @@ expression: debug_dump_memory(&mem)
│ index │ val_type │ value │
├───────┼──────────┼──────────────────────────────────────┤
│ 0 │ Uuid │ 4cd175a3-e313-4c91-b624-368bea3c0483 │
│ 2 │ Float │ 40 │
│ 3 │ Bool │ true │
│ 4 │ String │ png │
│ 1 │ Float │ 40 │
│ 2 │ Bool │ true │
│ 3 │ String │ png │
│ 4 │ Float │ -20 │
│ 5 │ Float │ -20 │
│ 6 │ Float │ -20 │
│ 7 │ Float │ -20 │
│ 8 │ Float │ -20 │
│ 9 │ String │ line │
│ 10 │ Float │ 20 │
│ 11 │ Float │ -20 │
│ 12 │ Float │ -20 │
│ 13 │ Bool │ false │
│ 14 │ String │ line │
│ 15 │ Float │ 20 │
│ 16 │ Float │ 20 │
│ 17 │ Float │ -20 │
│ 18 │ Bool │ false │
│ 19 │ String │ line │
│ 7 │ String │ line │
│ 8 │ Float │ 20 │
│ 9 │ Float │ -20 │
│ 10 │ Float │ -20 │
│ 11 │ Bool │ false │
│ 12 │ String │ line │
│ 13 │ Float │ 20 │
│ 14 │ Float │ 20 │
│ 15 │ Float │ -20 │
│ 16 │ Bool │ false │
│ 17 │ String │ line │
│ 18 │ Float │ -20 │
│ 19 │ Float │ 20 │
│ 20 │ Float │ -20 │
│ 21 │ Float │ 20 │
│ 22 │ Float │ -20 │
│ 23 │ Bool │ false │
│ 24 │ String │ line │
│ 21 │ Bool │ false │
│ 22 │ String │ line │
│ 23 │ Float │ -20 │
│ 24 │ Float │ -20 │
│ 25 │ Float │ -20 │
│ 26 │ Float │ -20 │
│ 27 │ Float │ -20 │
│ 28 │ Bool │ false │
│ 26 │ Bool │ false │
│ 99 │ String │ TAKE_SNAPSHOT │
│ 100 │ Bytes │ length 129068 │
└───────┴──────────┴──────────────────────────────────────┘
46 changes: 23 additions & 23 deletions execution-plan/src/snapshots/kittycad_execution_plan__tests__cube_memory_before.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ expression: debug_dump_memory(&mem)
│ index │ val_type │ value │
├───────┼──────────┼──────────────────────────────────────┤
│ 0 │ Uuid │ 4cd175a3-e313-4c91-b624-368bea3c0483 │
│ 2 │ Float │ 40 │
│ 3 │ Bool │ true │
│ 4 │ String │ png │
│ 1 │ Float │ 40 │
│ 2 │ Bool │ true │
│ 3 │ String │ png │
│ 4 │ Float │ -20 │
│ 5 │ Float │ -20 │
│ 6 │ Float │ -20 │
│ 7 │ Float │ -20 │
│ 8 │ Float │ -20 │
│ 9 │ String │ line │
│ 10 │ Float │ 20 │
│ 11 │ Float │ -20 │
│ 12 │ Float │ -20 │
│ 13 │ Bool │ false │
│ 14 │ String │ line │
│ 15 │ Float │ 20 │
│ 16 │ Float │ 20 │
│ 17 │ Float │ -20 │
│ 18 │ Bool │ false │
│ 19 │ String │ line │
│ 7 │ String │ line │
│ 8 │ Float │ 20 │
│ 9 │ Float │ -20 │
│ 10 │ Float │ -20 │
│ 11 │ Bool │ false │
│ 12 │ String │ line │
│ 13 │ Float │ 20 │
│ 14 │ Float │ 20 │
│ 15 │ Float │ -20 │
│ 16 │ Bool │ false │
│ 17 │ String │ line │
│ 18 │ Float │ -20 │
│ 19 │ Float │ 20 │
│ 20 │ Float │ -20 │
│ 21 │ Float │ 20 │
│ 22 │ Float │ -20 │
│ 23 │ Bool │ false │
│ 24 │ String │ line │
│ 21 │ Bool │ false │
│ 22 │ String │ line │
│ 23 │ Float │ -20 │
│ 24 │ Float │ -20 │
│ 25 │ Float │ -20 │
│ 26 │ Float │ -20 │
│ 27 │ Float │ -20 │
│ 28 │ Bool │ false │
│ 26 │ Bool │ false │
└───────┴──────────┴──────────────────────────────────────┘
82 changes: 28 additions & 54 deletions execution-plan/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,72 +127,46 @@ async fn add_to_composite_value() {

#[tokio::test]
async fn api_call_draw_cube() {
let mut mem = Memory::default();
let client = test_client().await;

const CUBE_WIDTH: f64 = 20.0;

// Define primitives, load them into memory.
let path_id_addr = Address(0);
let mut static_data = StaticMemoryInitializer::default();
let path = ModelingCmdId(Uuid::parse_str("4cd175a3-e313-4c91-b624-368bea3c0483").unwrap());
let cube_height_addr = Address(2);
let cube_height = Primitive::from(CUBE_WIDTH * 2.0);
let cap_addr = Address(3);
let cap = Primitive::Bool(true);
let img_format_addr = Address(4);
let img_format = Primitive::from("png".to_owned());
let path_id_addr = static_data.push(Primitive::from(path.0));
let cube_height_addr = static_data.push(Primitive::from(CUBE_WIDTH * 2.0));
let cap_addr = static_data.push(Primitive::from(true));
let img_format_addr = static_data.push(Primitive::from("png".to_owned()));
let output_addr = Address(99);
mem.set(path_id_addr, Primitive::from(path.0));
mem.set(cube_height_addr, cube_height);
mem.set(cap_addr, cap);
mem.set(img_format_addr, img_format);

// Define composite objects, load them into memory.
let starting_point_addr = Address(6);
let starting_point = Point3d {
x: -CUBE_WIDTH,
y: -CUBE_WIDTH,
z: -CUBE_WIDTH,
};
let point_size = mem.set_composite(starting_point_addr, starting_point);
let next_addr = Address(starting_point_addr.0 + point_size);
let segments =
[
PathSegment::Line {
end: Point3d {
x: CUBE_WIDTH,
y: -CUBE_WIDTH,
z: -CUBE_WIDTH,
},
relative: false,
},
PathSegment::Line {
end: Point3d {
x: CUBE_WIDTH,
y: CUBE_WIDTH,
z: -CUBE_WIDTH,
},
relative: false,
},
PathSegment::Line {
end: Point3d {
x: -CUBE_WIDTH,
y: CUBE_WIDTH,
z: -CUBE_WIDTH,
},
relative: false,
},
PathSegment::Line {
end: starting_point,
relative: false,
},
];
let mut segment_addrs = vec![next_addr];
for segment in segments {
let addr = segment_addrs.last().unwrap();
let size = mem.set_composite(*addr, segment);
segment_addrs.push(Address(addr.0 + size));
}
let starting_point_addr = static_data.push(starting_point);
let line_segment = |end: Point3d<f64>| PathSegment::Line { end, relative: false };
let segments = [
Point3d {
x: CUBE_WIDTH,
y: -CUBE_WIDTH,
z: -CUBE_WIDTH,
},
Point3d {
x: CUBE_WIDTH,
y: CUBE_WIDTH,
z: -CUBE_WIDTH,
},
Point3d {
x: -CUBE_WIDTH,
y: CUBE_WIDTH,
z: -CUBE_WIDTH,
},
starting_point,
]
.map(line_segment);
let segment_addrs = segments.map(|segment| static_data.push(segment));
let mut mem = static_data.finish();
assert_snapshot!("cube_memory_before", debug_dump_memory(&mem));

// Run the plan!
Expand Down
Loading