2015-05-19 17:38:23 +00:00
|
|
|
//: Spaces help isolate recipes from each other. You can create them at will,
|
2015-03-22 00:53:20 +00:00
|
|
|
//: and all addresses in arguments are implicitly based on the 'default-space'
|
|
|
|
//: (unless they have the /raw property)
|
|
|
|
|
2015-04-24 17:19:03 +00:00
|
|
|
:(scenario set_default_space)
|
2016-01-21 04:47:54 +00:00
|
|
|
# if default-space is 10, and if an array of 5 locals lies from location 12 to 16 (inclusive),
|
|
|
|
# then local 0 is really location 12, local 1 is really location 13, and so on.
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-09-17 20:00:39 +00:00
|
|
|
# pretend address:@:location; in practice we'll use new
|
2016-09-17 07:43:13 +00:00
|
|
|
10:num <- copy 0 # refcount
|
|
|
|
11:num <- copy 5 # length
|
2016-09-17 20:00:39 +00:00
|
|
|
default-space:&:@:location <- copy 10/unsafe
|
2016-09-17 07:43:13 +00:00
|
|
|
1:num <- copy 23
|
2015-03-22 00:53:20 +00:00
|
|
|
]
|
2016-01-21 04:47:54 +00:00
|
|
|
+mem: storing 23 in location 13
|
2015-03-22 00:53:20 +00:00
|
|
|
|
2015-07-28 22:03:46 +00:00
|
|
|
:(scenario lookup_sidesteps_default_space)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-04-24 18:54:30 +00:00
|
|
|
# pretend pointer from outside (2000 reserved for refcount)
|
2016-09-17 07:43:13 +00:00
|
|
|
2001:num <- copy 34
|
2016-09-17 20:00:39 +00:00
|
|
|
# pretend address:@:location; in practice we'll use new
|
2016-09-17 07:43:13 +00:00
|
|
|
1000:num <- copy 0 # refcount
|
|
|
|
1001:num <- copy 5 # length
|
2015-05-19 17:38:23 +00:00
|
|
|
# actual start of this recipe
|
2016-09-17 20:00:39 +00:00
|
|
|
default-space:&:@:location <- copy 1000/unsafe
|
2016-09-17 19:55:10 +00:00
|
|
|
1:&:num <- copy 2000/unsafe # even local variables always contain raw addresses
|
|
|
|
8:num/raw <- copy *1:&:num
|
2015-04-03 18:42:50 +00:00
|
|
|
]
|
|
|
|
+mem: storing 34 in location 8
|
|
|
|
|
2015-05-23 19:30:58 +00:00
|
|
|
//:: first disable name conversion for 'default-space'
|
|
|
|
:(scenario convert_names_passes_default_space)
|
2015-10-07 07:22:49 +00:00
|
|
|
% Hide_errors = true;
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-09-17 07:43:13 +00:00
|
|
|
default-space:num, x:num <- copy 0, 1
|
2015-05-23 19:30:58 +00:00
|
|
|
]
|
|
|
|
+name: assign x 1
|
|
|
|
-name: assign default-space 1
|
|
|
|
|
2016-01-30 05:58:00 +00:00
|
|
|
:(before "End is_disqualified Cases")
|
2015-05-23 19:30:58 +00:00
|
|
|
if (x.name == "default-space")
|
|
|
|
x.initialized = true;
|
|
|
|
:(before "End is_special_name Cases")
|
|
|
|
if (s == "default-space") return true;
|
|
|
|
|
|
|
|
//:: now implement space support
|
2015-04-13 03:56:45 +00:00
|
|
|
:(before "End call Fields")
|
2016-03-14 03:26:47 +00:00
|
|
|
int default_space;
|
2015-05-24 00:58:10 +00:00
|
|
|
:(before "End call Constructor")
|
|
|
|
default_space = 0;
|
2015-03-22 00:53:20 +00:00
|
|
|
|
2015-10-26 04:42:18 +00:00
|
|
|
:(before "End canonize(x) Special-cases")
|
2016-04-20 16:54:10 +00:00
|
|
|
absolutize(x);
|
2015-03-22 00:53:20 +00:00
|
|
|
:(code)
|
2015-10-26 04:42:18 +00:00
|
|
|
void absolutize(reagent& x) {
|
|
|
|
if (is_raw(x) || is_dummy(x)) return;
|
|
|
|
if (x.name == "default-space") return;
|
2016-08-17 19:18:27 +00:00
|
|
|
if (!x.initialized)
|
2016-05-21 05:09:06 +00:00
|
|
|
raise << to_original_string(current_instruction()) << ": reagent not initialized: '" << x.original_string << "'\n" << end();
|
2015-10-26 04:42:18 +00:00
|
|
|
x.set_value(address(x.value, space_base(x)));
|
2015-10-27 03:00:38 +00:00
|
|
|
x.properties.push_back(pair<string, string_tree*>("raw", NULL));
|
2015-10-26 04:42:18 +00:00
|
|
|
assert(is_raw(x));
|
2015-03-22 00:53:20 +00:00
|
|
|
}
|
|
|
|
|
2016-03-14 03:26:47 +00:00
|
|
|
int space_base(const reagent& x) {
|
2016-01-20 21:41:19 +00:00
|
|
|
// temporary stub; will be replaced in a later layer
|
2016-01-21 04:47:54 +00:00
|
|
|
return current_call().default_space ? (current_call().default_space+/*skip refcount*/1) : 0;
|
2016-01-20 21:41:19 +00:00
|
|
|
}
|
|
|
|
|
2016-03-14 03:26:47 +00:00
|
|
|
int address(int offset, int base) {
|
2016-02-27 05:50:54 +00:00
|
|
|
assert(offset >= 0);
|
2016-01-20 21:41:19 +00:00
|
|
|
if (base == 0) return offset; // raw
|
2016-03-14 03:26:47 +00:00
|
|
|
int size = get_or_insert(Memory, base);
|
2016-01-20 21:41:19 +00:00
|
|
|
if (offset >= size) {
|
|
|
|
// todo: test
|
2016-02-26 21:04:55 +00:00
|
|
|
raise << "location " << offset << " is out of bounds " << size << " at " << base << '\n' << end();
|
2016-01-20 21:41:19 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
return base + /*skip length*/1 + offset;
|
|
|
|
}
|
|
|
|
|
|
|
|
//:: reads and writes to the 'default-space' variable have special behavior
|
|
|
|
|
2016-05-06 15:33:15 +00:00
|
|
|
:(after "Begin Preprocess write_memory(x, data)")
|
2016-05-06 07:46:39 +00:00
|
|
|
if (x.name == "default-space") {
|
3309
Rip out everything to fix one failing unit test (commit 3290; type
abbreviations).
This commit does several things at once that I couldn't come up with a
clean way to unpack:
A. It moves to a new representation for type trees without changing
the actual definition of the `type_tree` struct.
B. It adds unit tests for our type metadata precomputation, so that
errors there show up early and in a simpler setting rather than dying
when we try to load Mu code.
C. It fixes a bug, guarding against infinite loops when precomputing
metadata for recursive shape-shifting containers. To do this it uses a
dumb way of comparing type_trees, comparing their string
representations instead. That is likely incredibly inefficient.
Perhaps due to C, this commit has made Mu incredibly slow. Running all
tests for the core and the edit/ app now takes 6.5 minutes rather than
3.5 minutes.
== more notes and details
I've been struggling for the past week now to back out of a bad design
decision, a premature optimization from the early days: storing atoms
directly in the 'value' slot of a cons cell rather than creating a
special 'atom' cons cell and storing it on the 'left' slot. In other
words, if a cons cell looks like this:
o
/ | \
left val right
..then the type_tree (a b c) used to look like this (before this
commit):
o
| \
a o
| \
b o
| \
c null
..rather than like this 'classic' approach to s-expressions which never
mixes val and right (which is what we now have):
o
/ \
o o
| / \
a o o
| / \
b o null
|
c
The old approach made several operations more complicated, most recently
the act of replacing a (possibly atom/leaf) sub-tree with another. That
was the final straw that got me to realize the contortions I was going
through to save a few type_tree nodes (cons cells).
Switching to the new approach was hard partly because I've been using
the old approach for so long and type_tree manipulations had pervaded
everything. Another issue I ran into was the realization that my layers
were not cleanly separated. Key parts of early layers (precomputing type
metadata) existed purely for far later ones (shape-shifting types).
Layers I got repeatedly stuck at:
1. the transform for precomputing type sizes (layer 30)
2. type-checks on merge instructions (layer 31)
3. the transform for precomputing address offsets in types (layer 36)
4. replace operations in supporting shape-shifting recipes (layer 55)
After much thrashing I finally noticed that it wasn't the entirety of
these layers that was giving me trouble, but just the type metadata
precomputation, which had bugs that weren't manifesting until 30 layers
later. Or, worse, when loading .mu files before any tests had had a
chance to run. A common failure mode was running into types at run time
that I hadn't precomputed metadata for at transform time.
Digging into these bugs got me to realize that what I had before wasn't
really very good, but a half-assed heuristic approach that did a whole
lot of extra work precomputing metadata for utterly meaningless types
like `((address number) 3)` which just happened to be part of a larger
type like `(array (address number) 3)`.
So, I redid it all. I switched the representation of types (because the
old representation made unit tests difficult to retrofit) and added unit
tests to the metadata precomputation. I also made layer 30 only do the
minimal metadata precomputation it needs for the concepts introduced
until then. In the process, I also made the precomputation more correct
than before, and added hooks in the right place so that I could augment
the logic when I introduced shape-shifting containers.
== lessons learned
There's several levels of hygiene when it comes to layers:
1. Every layer introduces precisely what it needs and in the simplest
way possible. If I was building an app until just that layer, nothing
would seem over-engineered.
2. Some layers are fore-shadowing features in future layers. Sometimes
this is ok. For example, layer 10 foreshadows containers and arrays and
so on without actually supporting them. That is a net win because it
lets me lay out the core of Mu's data structures out in one place. But
if the fore-shadowing gets too complex things get nasty. Not least
because it can be hard to write unit tests for features before you
provide the plumbing to visualize and manipulate them.
3. A layer is introducing features that are tested only in later layers.
4. A layer is introducing features with tests that are invalidated in
later layers. (This I knew from early on to be an obviously horrendous
idea.)
Summary: avoid Level 2 (foreshadowing layers) as much as possible.
Tolerate it indefinitely for small things where the code stays simple
over time, but become strict again when things start to get more
complex.
Level 3 is mostly a net lose, but sometimes it can be expedient (a real
case of the usually grossly over-applied term "technical debt"), and
it's better than the conventional baseline of no layers and no
scenarios. Just clean it up as soon as possible.
Definitely avoid layer 4 at any time.
== minor lessons
Avoid unit tests for trivial things, write scenarios in context as much as
possible. But within those margins unit tests are fine. Just introduce them
before any scenarios (commit 3297).
Reorganizing layers can be easy. Just merge layers for starters! Punt on
resplitting them in some new way until you've gotten them to work. This is the
wisdom of Refactoring: small steps.
What made it hard was not wanting to merge *everything* between layer 30
and 55. The eventual insight was realizing I just need to move those two
full-strength transforms and nothing else.
2016-09-10 01:32:52 +00:00
|
|
|
if (!scalar(data) || !is_space(x))
|
2016-09-17 20:00:39 +00:00
|
|
|
raise << maybe(current_recipe_name()) << "'default-space' should be of type address:@:location, but is " << to_string(x.type) << '\n' << end();
|
2016-05-06 07:46:39 +00:00
|
|
|
current_call().default_space = data.at(0);
|
|
|
|
return;
|
|
|
|
}
|
3309
Rip out everything to fix one failing unit test (commit 3290; type
abbreviations).
This commit does several things at once that I couldn't come up with a
clean way to unpack:
A. It moves to a new representation for type trees without changing
the actual definition of the `type_tree` struct.
B. It adds unit tests for our type metadata precomputation, so that
errors there show up early and in a simpler setting rather than dying
when we try to load Mu code.
C. It fixes a bug, guarding against infinite loops when precomputing
metadata for recursive shape-shifting containers. To do this it uses a
dumb way of comparing type_trees, comparing their string
representations instead. That is likely incredibly inefficient.
Perhaps due to C, this commit has made Mu incredibly slow. Running all
tests for the core and the edit/ app now takes 6.5 minutes rather than
3.5 minutes.
== more notes and details
I've been struggling for the past week now to back out of a bad design
decision, a premature optimization from the early days: storing atoms
directly in the 'value' slot of a cons cell rather than creating a
special 'atom' cons cell and storing it on the 'left' slot. In other
words, if a cons cell looks like this:
o
/ | \
left val right
..then the type_tree (a b c) used to look like this (before this
commit):
o
| \
a o
| \
b o
| \
c null
..rather than like this 'classic' approach to s-expressions which never
mixes val and right (which is what we now have):
o
/ \
o o
| / \
a o o
| / \
b o null
|
c
The old approach made several operations more complicated, most recently
the act of replacing a (possibly atom/leaf) sub-tree with another. That
was the final straw that got me to realize the contortions I was going
through to save a few type_tree nodes (cons cells).
Switching to the new approach was hard partly because I've been using
the old approach for so long and type_tree manipulations had pervaded
everything. Another issue I ran into was the realization that my layers
were not cleanly separated. Key parts of early layers (precomputing type
metadata) existed purely for far later ones (shape-shifting types).
Layers I got repeatedly stuck at:
1. the transform for precomputing type sizes (layer 30)
2. type-checks on merge instructions (layer 31)
3. the transform for precomputing address offsets in types (layer 36)
4. replace operations in supporting shape-shifting recipes (layer 55)
After much thrashing I finally noticed that it wasn't the entirety of
these layers that was giving me trouble, but just the type metadata
precomputation, which had bugs that weren't manifesting until 30 layers
later. Or, worse, when loading .mu files before any tests had had a
chance to run. A common failure mode was running into types at run time
that I hadn't precomputed metadata for at transform time.
Digging into these bugs got me to realize that what I had before wasn't
really very good, but a half-assed heuristic approach that did a whole
lot of extra work precomputing metadata for utterly meaningless types
like `((address number) 3)` which just happened to be part of a larger
type like `(array (address number) 3)`.
So, I redid it all. I switched the representation of types (because the
old representation made unit tests difficult to retrofit) and added unit
tests to the metadata precomputation. I also made layer 30 only do the
minimal metadata precomputation it needs for the concepts introduced
until then. In the process, I also made the precomputation more correct
than before, and added hooks in the right place so that I could augment
the logic when I introduced shape-shifting containers.
== lessons learned
There's several levels of hygiene when it comes to layers:
1. Every layer introduces precisely what it needs and in the simplest
way possible. If I was building an app until just that layer, nothing
would seem over-engineered.
2. Some layers are fore-shadowing features in future layers. Sometimes
this is ok. For example, layer 10 foreshadows containers and arrays and
so on without actually supporting them. That is a net win because it
lets me lay out the core of Mu's data structures out in one place. But
if the fore-shadowing gets too complex things get nasty. Not least
because it can be hard to write unit tests for features before you
provide the plumbing to visualize and manipulate them.
3. A layer is introducing features that are tested only in later layers.
4. A layer is introducing features with tests that are invalidated in
later layers. (This I knew from early on to be an obviously horrendous
idea.)
Summary: avoid Level 2 (foreshadowing layers) as much as possible.
Tolerate it indefinitely for small things where the code stays simple
over time, but become strict again when things start to get more
complex.
Level 3 is mostly a net lose, but sometimes it can be expedient (a real
case of the usually grossly over-applied term "technical debt"), and
it's better than the conventional baseline of no layers and no
scenarios. Just clean it up as soon as possible.
Definitely avoid layer 4 at any time.
== minor lessons
Avoid unit tests for trivial things, write scenarios in context as much as
possible. But within those margins unit tests are fine. Just introduce them
before any scenarios (commit 3297).
Reorganizing layers can be easy. Just merge layers for starters! Punt on
resplitting them in some new way until you've gotten them to work. This is the
wisdom of Refactoring: small steps.
What made it hard was not wanting to merge *everything* between layer 30
and 55. The eventual insight was realizing I just need to move those two
full-strength transforms and nothing else.
2016-09-10 01:32:52 +00:00
|
|
|
:(code)
|
|
|
|
bool is_space(const reagent& r) {
|
|
|
|
return is_address_of_array_of_numbers(r);
|
|
|
|
}
|
2016-01-20 21:41:19 +00:00
|
|
|
|
|
|
|
:(scenario get_default_space)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-09-17 20:00:39 +00:00
|
|
|
default-space:&:@:location <- copy 10/unsafe
|
|
|
|
1:&:@:location/raw <- copy default-space:&:@:location
|
2016-01-20 21:41:19 +00:00
|
|
|
]
|
|
|
|
+mem: storing 10 in location 1
|
|
|
|
|
2016-05-06 15:33:15 +00:00
|
|
|
:(after "Begin Preprocess read_memory(x)")
|
2016-05-06 07:46:39 +00:00
|
|
|
if (x.name == "default-space") {
|
|
|
|
vector<double> result;
|
|
|
|
result.push_back(current_call().default_space);
|
|
|
|
return result;
|
|
|
|
}
|
2016-01-20 21:41:19 +00:00
|
|
|
|
2015-04-18 06:24:52 +00:00
|
|
|
//:: fix 'get'
|
|
|
|
|
2015-07-28 22:03:46 +00:00
|
|
|
:(scenario lookup_sidesteps_default_space_in_get)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-04-24 18:54:30 +00:00
|
|
|
# pretend pointer to container from outside (2000 reserved for refcount)
|
2016-09-17 07:43:13 +00:00
|
|
|
2001:num <- copy 34
|
|
|
|
2002:num <- copy 35
|
2016-09-17 20:00:39 +00:00
|
|
|
# pretend address:@:location; in practice we'll use new
|
2016-09-17 07:43:13 +00:00
|
|
|
1000:num <- copy 0 # refcount
|
|
|
|
1001:num <- copy 5 # length
|
2015-05-19 17:38:23 +00:00
|
|
|
# actual start of this recipe
|
2016-09-17 20:00:39 +00:00
|
|
|
default-space:&:@:location <- copy 1000/unsafe
|
2016-09-17 19:55:10 +00:00
|
|
|
1:&:point <- copy 2000/unsafe
|
|
|
|
9:num/raw <- get *1:&:point, 1:offset
|
2015-04-18 04:51:13 +00:00
|
|
|
]
|
|
|
|
+mem: storing 35 in location 9
|
|
|
|
|
2016-04-20 16:58:07 +00:00
|
|
|
:(before "Read element" following "case GET:")
|
|
|
|
element.properties.push_back(pair<string, string_tree*>("raw", NULL));
|
2015-04-18 04:51:13 +00:00
|
|
|
|
2015-04-18 06:24:52 +00:00
|
|
|
//:: fix 'index'
|
|
|
|
|
2015-07-28 22:03:46 +00:00
|
|
|
:(scenario lookup_sidesteps_default_space_in_index)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-04-24 18:54:30 +00:00
|
|
|
# pretend pointer to array from outside (2000 reserved for refcount)
|
2016-09-17 07:43:13 +00:00
|
|
|
2001:num <- copy 2 # length
|
|
|
|
2002:num <- copy 34
|
|
|
|
2003:num <- copy 35
|
2016-09-17 20:00:39 +00:00
|
|
|
# pretend address:@:location; in practice we'll use new
|
2016-09-17 07:43:13 +00:00
|
|
|
1000:num <- copy 0 # refcount
|
|
|
|
1001:num <- copy 5 # length
|
2015-05-19 17:38:23 +00:00
|
|
|
# actual start of this recipe
|
2016-09-17 20:00:39 +00:00
|
|
|
default-space:&:@:location <- copy 1000/unsafe
|
|
|
|
1:&:@:num <- copy 2000/unsafe
|
|
|
|
9:num/raw <- index *1:&:@:num, 1
|
2015-04-18 04:51:13 +00:00
|
|
|
]
|
|
|
|
+mem: storing 35 in location 9
|
|
|
|
|
2016-04-20 16:58:07 +00:00
|
|
|
:(before "Read element" following "case INDEX:")
|
|
|
|
element.properties.push_back(pair<string, string_tree*>("raw", NULL));
|
2015-04-18 04:51:13 +00:00
|
|
|
|
2015-07-14 02:59:27 +00:00
|
|
|
//:: convenience operation to automatically deduce the amount of space to
|
|
|
|
//:: allocate in a default space with names
|
|
|
|
|
|
|
|
:(scenario new_default_space)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2015-07-14 02:59:27 +00:00
|
|
|
new-default-space
|
2016-09-17 07:43:13 +00:00
|
|
|
x:num <- copy 0
|
|
|
|
y:num <- copy 3
|
2015-07-14 02:59:27 +00:00
|
|
|
]
|
|
|
|
# allocate space for x and y, as well as the chaining slot at 0
|
2016-08-26 20:47:39 +00:00
|
|
|
+mem: array length is 3
|
2015-07-14 02:59:27 +00:00
|
|
|
|
2016-01-30 05:58:00 +00:00
|
|
|
:(before "End is_disqualified Cases")
|
2015-07-14 02:59:27 +00:00
|
|
|
if (x.name == "number-of-locals")
|
|
|
|
x.initialized = true;
|
|
|
|
:(before "End is_special_name Cases")
|
|
|
|
if (s == "number-of-locals") return true;
|
|
|
|
|
2015-10-29 01:19:41 +00:00
|
|
|
:(before "End Rewrite Instruction(curr, recipe result)")
|
2015-07-14 02:59:27 +00:00
|
|
|
// rewrite `new-default-space` to
|
2016-09-17 20:00:39 +00:00
|
|
|
// `default-space:&:@:location <- new location:type, number-of-locals:literal`
|
2015-07-14 02:59:27 +00:00
|
|
|
// where N is Name[recipe][""]
|
|
|
|
if (curr.name == "new-default-space") {
|
2015-07-14 05:43:16 +00:00
|
|
|
rewrite_default_space_instruction(curr);
|
2015-07-14 02:59:27 +00:00
|
|
|
}
|
2016-05-06 15:33:15 +00:00
|
|
|
:(after "Begin Preprocess read_memory(x)")
|
2016-05-06 07:46:39 +00:00
|
|
|
if (x.name == "number-of-locals") {
|
|
|
|
vector<double> result;
|
|
|
|
result.push_back(Name[get(Recipe_ordinal, current_recipe_name())][""]);
|
|
|
|
if (result.back() == 0)
|
|
|
|
raise << "no space allocated for default-space in recipe " << current_recipe_name() << "; are you using names?\n" << end();
|
|
|
|
return result;
|
|
|
|
}
|
2016-05-06 15:33:15 +00:00
|
|
|
:(after "Begin Preprocess write_memory(x, data)")
|
2016-05-06 07:46:39 +00:00
|
|
|
if (x.name == "number-of-locals") {
|
|
|
|
raise << maybe(current_recipe_name()) << "can't write to special name 'number-of-locals'\n" << end();
|
|
|
|
return;
|
|
|
|
}
|
2015-07-14 02:59:27 +00:00
|
|
|
|
2016-05-18 23:45:32 +00:00
|
|
|
//:: 'local-scope' is like 'new-default-space' except that we'll reclaim the
|
|
|
|
//:: default-space when the routine exits
|
2015-07-14 05:43:16 +00:00
|
|
|
|
|
|
|
:(scenario local_scope)
|
2016-03-08 09:30:14 +00:00
|
|
|
def main [
|
2016-09-17 19:55:10 +00:00
|
|
|
1:& <- foo
|
|
|
|
2:& <- foo
|
|
|
|
3:bool <- equal 1:&, 2:&
|
2015-07-14 05:43:16 +00:00
|
|
|
]
|
2016-03-08 09:30:14 +00:00
|
|
|
def foo [
|
2015-07-14 05:43:16 +00:00
|
|
|
local-scope
|
2016-09-17 07:43:13 +00:00
|
|
|
x:num <- copy 34
|
2016-09-17 20:00:39 +00:00
|
|
|
return default-space:&:@:location
|
2015-07-14 05:43:16 +00:00
|
|
|
]
|
|
|
|
# both calls to foo should have received the same default-space
|
|
|
|
+mem: storing 1 in location 3
|
|
|
|
|
2016-05-18 23:45:32 +00:00
|
|
|
:(scenario local_scope_frees_up_addresses)
|
|
|
|
def main [
|
|
|
|
local-scope
|
2016-09-17 07:06:04 +00:00
|
|
|
x:text <- new [abc]
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
2016-09-17 07:06:04 +00:00
|
|
|
+mem: clearing x:text
|
2016-05-18 23:45:32 +00:00
|
|
|
|
|
|
|
:(before "End Rewrite Instruction(curr, recipe result)")
|
|
|
|
if (curr.name == "local-scope") {
|
|
|
|
rewrite_default_space_instruction(curr);
|
|
|
|
}
|
2016-03-13 04:41:35 +00:00
|
|
|
|
|
|
|
//: todo: do this in a transform, rather than magically in the reply instruction
|
2015-07-14 05:43:16 +00:00
|
|
|
:(after "Falling Through End Of Recipe")
|
|
|
|
try_reclaim_locals();
|
|
|
|
:(after "Starting Reply")
|
|
|
|
try_reclaim_locals();
|
|
|
|
|
|
|
|
:(code)
|
|
|
|
void try_reclaim_locals() {
|
|
|
|
// only reclaim routines starting with 'local-scope'
|
2015-11-06 19:06:58 +00:00
|
|
|
const recipe_ordinal r = get(Recipe_ordinal, current_recipe_name());
|
2016-03-13 03:24:38 +00:00
|
|
|
const recipe& exiting_recipe = get(Recipe, r);
|
|
|
|
if (exiting_recipe.steps.empty()) return;
|
|
|
|
const instruction& inst = exiting_recipe.steps.at(0);
|
2015-10-30 00:15:09 +00:00
|
|
|
if (inst.old_name != "local-scope") return;
|
2016-03-13 04:41:35 +00:00
|
|
|
// reclaim any local variables unless they're being returned
|
2016-05-18 23:45:32 +00:00
|
|
|
vector<double> zeros;
|
|
|
|
for (int i = /*leave default space for last*/1; i < SIZE(exiting_recipe.steps); ++i) {
|
|
|
|
const instruction& inst = exiting_recipe.steps.at(i);
|
|
|
|
for (int i = 0; i < SIZE(inst.products); ++i) {
|
2016-08-26 17:58:20 +00:00
|
|
|
const reagent& product = inst.products.at(i);
|
2016-05-18 23:45:32 +00:00
|
|
|
// local variables only
|
2016-08-26 17:58:20 +00:00
|
|
|
if (has_property(product, "lookup")) continue;
|
|
|
|
if (has_property(product, "raw")) continue; // tests often want to check such locations after they run
|
|
|
|
if (escaping(product)) continue;
|
2016-08-17 19:20:48 +00:00
|
|
|
// End Checks For Reclaiming Locals
|
2016-08-26 17:58:20 +00:00
|
|
|
trace(9999, "mem") << "clearing " << product.original_string << end();
|
|
|
|
zeros.resize(size_of(product));
|
|
|
|
write_memory(product, zeros);
|
2016-05-18 23:45:32 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
trace(9999, "mem") << "automatically abandoning " << current_call().default_space << end();
|
2015-10-28 13:27:01 +00:00
|
|
|
abandon(current_call().default_space,
|
2016-05-18 01:32:41 +00:00
|
|
|
inst.products.at(0).type->right,
|
2016-01-21 04:47:54 +00:00
|
|
|
/*refcount*/1 + /*array length*/1 + /*number-of-locals*/Name[r][""]);
|
2015-07-14 05:43:16 +00:00
|
|
|
}
|
|
|
|
|
2016-08-16 21:41:49 +00:00
|
|
|
:(code)
|
|
|
|
// is this reagent one of the values returned by the current (reply) instruction?
|
|
|
|
// is the corresponding ingredient saved in the caller?
|
|
|
|
bool escaping(const reagent& r) {
|
|
|
|
assert(Current_routine); // run-time only
|
|
|
|
// nothing escapes when you fall through past end of recipe
|
|
|
|
if (current_step_index() >= SIZE(Current_routine->steps())) return false;
|
|
|
|
for (long long i = 0; i < SIZE(current_instruction().ingredients); ++i) {
|
|
|
|
if (r == current_instruction().ingredients.at(i)) {
|
2016-08-26 17:58:20 +00:00
|
|
|
if (caller_uses_product(i))
|
|
|
|
return true;
|
2016-08-16 21:41:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2016-05-18 23:45:32 +00:00
|
|
|
//: since we don't decrement refcounts for escaping values above, make sure we
|
|
|
|
//: don't increment them when the caller saves them either
|
|
|
|
|
2016-08-16 21:52:05 +00:00
|
|
|
:(after "Write Products of Instruction")
|
|
|
|
Update_refcounts_in_write_memory = should_update_refcounts_in_write_memory();
|
|
|
|
:(before "End Write Products of Instruction")
|
|
|
|
Update_refcounts_in_write_memory = true;
|
|
|
|
:(code)
|
|
|
|
bool should_update_refcounts_in_write_memory() {
|
2016-05-18 23:45:32 +00:00
|
|
|
const instruction& inst = current_instruction();
|
2016-08-17 00:03:27 +00:00
|
|
|
// End should_update_refcounts_in_write_memory Special-cases For Primitives
|
2016-05-18 23:45:32 +00:00
|
|
|
if (inst.operation < MAX_PRIMITIVE_RECIPES) return true;
|
|
|
|
if (!contains_key(Recipe, inst.operation)) return true;
|
2016-08-17 19:23:48 +00:00
|
|
|
const recipe& callee = get(Recipe, inst.operation);
|
|
|
|
if (callee.steps.empty()) return true;
|
|
|
|
return callee.steps.at(0).old_name != "local-scope"; // callees that call local-scope are already dealt with before return
|
2016-05-18 23:45:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool caller_uses_product(int product_index) {
|
|
|
|
assert(Current_routine); // run-time only
|
|
|
|
assert(!Current_routine->calls.empty());
|
|
|
|
if (Current_routine->calls.size() == 1) return false;
|
|
|
|
const call& caller = *++Current_routine->calls.begin();
|
|
|
|
const instruction& caller_inst = to_instruction(caller);
|
|
|
|
if (product_index >= SIZE(caller_inst.products)) return false;
|
|
|
|
return !is_dummy(caller_inst.products.at(product_index));
|
|
|
|
}
|
|
|
|
|
2015-07-14 05:43:16 +00:00
|
|
|
void rewrite_default_space_instruction(instruction& curr) {
|
|
|
|
if (!curr.ingredients.empty())
|
2016-03-21 09:25:52 +00:00
|
|
|
raise << to_original_string(curr) << " can't take any ingredients\n" << end();
|
2015-10-30 00:15:09 +00:00
|
|
|
curr.name = "new";
|
2015-07-14 05:43:16 +00:00
|
|
|
curr.ingredients.push_back(reagent("location:type"));
|
|
|
|
curr.ingredients.push_back(reagent("number-of-locals:literal"));
|
|
|
|
if (!curr.products.empty())
|
2016-02-26 21:04:55 +00:00
|
|
|
raise << "new-default-space can't take any results\n" << end();
|
2016-09-17 20:00:39 +00:00
|
|
|
curr.products.push_back(reagent("default-space:&:@:location"));
|
2015-07-14 05:43:16 +00:00
|
|
|
}
|
2016-01-28 03:59:29 +00:00
|
|
|
|
2016-05-18 23:45:32 +00:00
|
|
|
:(scenario local_scope_frees_up_addresses_inside_containers)
|
|
|
|
container foo [
|
2016-09-17 07:43:13 +00:00
|
|
|
x:num
|
2016-09-17 19:55:10 +00:00
|
|
|
y:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
|
|
|
def main [
|
|
|
|
local-scope
|
2016-09-17 19:55:10 +00:00
|
|
|
x:&:num <- new number:type
|
|
|
|
y:foo <- merge 34, x:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
# x and y are both cleared when main returns
|
|
|
|
]
|
2016-09-17 19:55:10 +00:00
|
|
|
+mem: clearing x:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
+mem: decrementing refcount of 1006: 2 -> 1
|
|
|
|
+mem: clearing y:foo
|
|
|
|
+mem: decrementing refcount of 1006: 1 -> 0
|
|
|
|
+mem: automatically abandoning 1006
|
|
|
|
|
|
|
|
:(scenario local_scope_returns_addresses_inside_containers)
|
|
|
|
container foo [
|
2016-09-17 07:43:13 +00:00
|
|
|
x:num
|
2016-09-17 19:55:10 +00:00
|
|
|
y:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
|
|
|
def f [
|
|
|
|
local-scope
|
2016-09-17 19:55:10 +00:00
|
|
|
x:&:num <- new number:type
|
|
|
|
*x:&:num <- copy 12
|
|
|
|
y:foo <- merge 34, x:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
# since y is 'escaping' f, it should not be cleared
|
2016-05-19 00:05:22 +00:00
|
|
|
return y:foo
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
|
|
|
def main [
|
|
|
|
1:foo <- f
|
2016-09-17 07:43:13 +00:00
|
|
|
3:num <- get 1:foo, x:offset
|
2016-09-17 19:55:10 +00:00
|
|
|
4:&:num <- get 1:foo, y:offset
|
|
|
|
5:num <- copy *4:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
1:foo <- put 1:foo, y:offset, 0
|
2016-09-17 19:55:10 +00:00
|
|
|
4:&:num <- copy 0
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
|
|
|
+mem: storing 34 in location 1
|
|
|
|
+mem: storing 1006 in location 2
|
|
|
|
+mem: storing 34 in location 3
|
|
|
|
# refcount of 1:foo shouldn't include any stray ones from f
|
|
|
|
+run: {4: ("address" "number")} <- get {1: "foo"}, {y: "offset"}
|
|
|
|
+mem: incrementing refcount of 1006: 1 -> 2
|
|
|
|
# 1:foo wasn't abandoned/cleared
|
|
|
|
+run: {5: "number"} <- copy {4: ("address" "number"), "lookup": ()}
|
|
|
|
+mem: storing 12 in location 5
|
|
|
|
+run: {1: "foo"} <- put {1: "foo"}, {y: "offset"}, {0: "literal"}
|
|
|
|
+mem: decrementing refcount of 1006: 2 -> 1
|
|
|
|
+run: {4: ("address" "number")} <- copy {0: "literal"}
|
|
|
|
+mem: decrementing refcount of 1006: 1 -> 0
|
|
|
|
+mem: automatically abandoning 1006
|
|
|
|
|
|
|
|
:(scenario local_scope_claims_return_values_when_not_saved)
|
|
|
|
def f [
|
|
|
|
local-scope
|
2016-09-17 19:55:10 +00:00
|
|
|
x:&:num <- new number:type
|
|
|
|
reply x:&:num
|
2016-05-18 23:45:32 +00:00
|
|
|
]
|
|
|
|
def main [
|
|
|
|
f # doesn't save result
|
|
|
|
]
|
|
|
|
# x reclaimed
|
|
|
|
+mem: automatically abandoning 1004
|
|
|
|
# f's local scope reclaimed
|
|
|
|
+mem: automatically abandoning 1000
|
|
|
|
|
2016-01-28 03:59:29 +00:00
|
|
|
//:: all recipes must set default-space one way or another
|
|
|
|
|
|
|
|
:(before "End Globals")
|
2016-02-25 16:24:14 +00:00
|
|
|
bool Hide_missing_default_space_errors = true;
|
2016-01-28 03:59:29 +00:00
|
|
|
:(before "End Checks")
|
|
|
|
Transform.push_back(check_default_space); // idempotent
|
|
|
|
:(code)
|
|
|
|
void check_default_space(const recipe_ordinal r) {
|
2016-02-25 16:24:14 +00:00
|
|
|
if (Hide_missing_default_space_errors) return; // skip previous core tests; this is only for mu code
|
2016-01-28 03:59:29 +00:00
|
|
|
const recipe& caller = get(Recipe, r);
|
|
|
|
// skip scenarios (later layer)
|
|
|
|
// user code should never create recipes with underscores in their names
|
|
|
|
if (caller.name.find("scenario_") == 0) return; // skip mu scenarios which will use raw memory locations
|
|
|
|
if (caller.name.find("run_") == 0) return; // skip calls to 'run', which should be in scenarios and will also use raw memory locations
|
|
|
|
// assume recipes with only numeric addresses know what they're doing (usually tests)
|
|
|
|
if (!contains_non_special_name(r)) return;
|
|
|
|
trace(9991, "transform") << "--- check that recipe " << caller.name << " sets default-space" << end();
|
|
|
|
if (caller.steps.empty()) return;
|
|
|
|
if (caller.steps.at(0).products.empty()
|
|
|
|
|| caller.steps.at(0).products.at(0).name != "default-space") {
|
2016-05-21 05:09:06 +00:00
|
|
|
raise << caller.name << " does not seem to start with default-space or local-scope\n" << end();
|
2016-01-28 03:59:29 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
:(after "Load .mu Core")
|
2016-02-25 16:24:14 +00:00
|
|
|
Hide_missing_default_space_errors = false;
|
2016-01-28 03:59:29 +00:00
|
|
|
:(after "Test Runs")
|
2016-02-25 16:24:14 +00:00
|
|
|
Hide_missing_default_space_errors = true;
|
2016-01-28 03:59:29 +00:00
|
|
|
:(after "Running Main")
|
2016-02-25 16:24:14 +00:00
|
|
|
Hide_missing_default_space_errors = false;
|
2016-01-28 03:59:29 +00:00
|
|
|
|
|
|
|
:(code)
|
|
|
|
bool contains_non_special_name(const recipe_ordinal r) {
|
2016-03-14 03:26:47 +00:00
|
|
|
for (map<string, int>::iterator p = Name[r].begin(); p != Name[r].end(); ++p) {
|
2016-01-28 03:59:29 +00:00
|
|
|
if (p->first.empty()) continue;
|
2016-02-10 23:46:50 +00:00
|
|
|
if (p->first.find("stash_") == 0) continue; // generated by rewrite_stashes_to_text (cross-layer)
|
2016-02-26 04:47:42 +00:00
|
|
|
if (!is_special_name(p->first))
|
2016-01-28 03:59:29 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2016-03-05 03:22:09 +00:00
|
|
|
|
|
|
|
// reagent comparison -- only between reagents in a single recipe
|
|
|
|
bool operator==(const reagent& a, const reagent& b) {
|
|
|
|
if (a.name != b.name) return false;
|
|
|
|
if (property(a, "space") != property(b, "space")) return false;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool operator<(const reagent& a, const reagent& b) {
|
2016-03-14 03:26:47 +00:00
|
|
|
int aspace = 0, bspace = 0;
|
2016-03-05 03:22:09 +00:00
|
|
|
if (has_property(a, "space")) aspace = to_integer(property(a, "space")->value);
|
|
|
|
if (has_property(b, "space")) bspace = to_integer(property(b, "space")->value);
|
|
|
|
if (aspace != bspace) return aspace < bspace;
|
|
|
|
return a.name < b.name;
|
|
|
|
}
|