1 //: Phase 3: Start running a loaded and transformed recipe.
  2 //:
  3 //:   The process of running Mu code:
  4 //:     load -> transform -> run
  5 //:
  6 //: So far we've seen recipes as lists of instructions, and instructions point
  7 //: at other recipes. To kick things off Mu needs to know how to run certain
  8 //: 'primitive' recipes. That will then give the ability to run recipes
  9 //: containing these primitives.
 10 //:
 11 //: This layer defines a skeleton with just two primitive recipes: IDLE which
 12 //: does nothing, and COPY, which can copy numbers from one memory location to
 13 //: another. Later layers will add more primitives.
 14 
 15 :(scenario copy_literal)
 16 def main [
 17   1:num <- copy 23
 18 ]
 19 +run: {1: "number"} <- copy {23: "literal"}
 20 +mem: storing 23 in location 1
 21 
 22 :(scenario copy)
 23 def main [
 24   1:num <- copy 23
 25   2:num <- copy 1:num
 26 ]
 27 +run: {2: "number"} <- copy {1: "number"}
 28 +mem: location 1 is 23
 29 +mem: storing 23 in location 2
 30 
 31 :(scenario copy_multiple)
 32 def main [
 33   1:num, 2:num <- copy 23, 24
 34 ]
 35 +mem: storing 23 in location 1
 36 +mem: storing 24 in location 2
 37 
 38 :(before "End Types")
 39 // Book-keeping while running a recipe.
 40 //: Later layers will replace this to support running multiple routines at once.
 41 struct routine {
 42   recipe_ordinal running_recipe;
 43   int running_step_index;
 44   routine(recipe_ordinal r) :running_recipe(r), running_step_index(0) {}
 45   bool completed() const;
 46   const vector<instruction>& steps() const;
 47 };
 48 
 49 :(before "End Globals")
 50 routine* Current_routine = NULL;
 51 map<string, int> Instructions_running;
 52 map<string, int> Locations_read;
 53 map<string, int> Locations_read_by_instruction;
 54 :(before "End Setup")
 55 Current_routine = NULL;
 56 
 57 :(code)
 58 void run(const recipe_ordinal r) {
 59   routine rr(r);
 60   Current_routine = &rr;
 61   run_current_routine();
 62   Current_routine = NULL;
 63 }
 64 
 65 void run_current_routine() {
 66   while (should_continue_running(Current_routine)) {  // beware: may modify Current_routine
 67   ¦ // Running One Instruction
 68 //?     Instructions_running[current_recipe_name()]++;
 69   ¦ if (current_instruction().is_label) { ++current_step_index();  continue; }
 70   ¦ trace(Initial_callstack_depth + Trace_stream->callstack_depth, "run") << to_string(current_instruction()) << end();
 71   ¦ if (get_or_insert(Memory, 0) != 0) {
 72   ¦ ¦ raise << "something wrote to location 0; this should never happen\n" << end();
 73   ¦ ¦ put(Memory, 0, 0);
 74   ¦ }
 75   ¦ // read all ingredients from memory, each potentially spanning multiple locations
 76   ¦ vector<vector<double> > ingredients;
 77   ¦ if (should_copy_ingredients()) {
 78   ¦ ¦ for (int i = 0;  i < SIZE(current_instruction().ingredients);  ++i)
 79   ¦ ¦ ¦ ingredients.push_back(read_memory(current_instruction().ingredients.at(i)));
 80   ¦ }
 81   ¦ // instructions below will write to 'products'
 82   ¦ vector<vector<double> > products;
 83   ¦ switch (current_instruction().operation) {
 84   ¦ ¦ // Primitive Recipe Implementations
 85   ¦ ¦ case COPY: {
 86   ¦ ¦ ¦ copy(ingredients.begin(), ingredients.end(), inserter(products, products.begin()));
 87   ¦ ¦ ¦ break;
 88   ¦ ¦ }
 89   ¦ ¦ // End Primitive Recipe Implementations
 90   ¦ ¦ default: {
 91   ¦ ¦ ¦ cout << "not a primitive op: " << current_instruction().operation << '\n';
 92   ¦ ¦ }
 93   ¦ }
 94   ¦ //: used by a later layer
 95   ¦ Writing_products_of_instruction = true;
 96   ¦ if (SIZE(products) < SIZE(current_instruction().products)) {
 97   ¦ ¦ raise << SIZE(products) << " vs " << SIZE(current_instruction().products) << ": failed to write to all products in '" << current_instruction().original_string << "'\n" << end();
 98   ¦ }
 99   ¦ else {
100   ¦ ¦ for (int i = 0;  i < SIZE(current_instruction().products);  ++i)
101   ¦ ¦ ¦ write_memory(current_instruction().products.at(i), products.at(i));
102   ¦ }
103   ¦ Writing_products_of_instruction = false;
104   ¦ // End Running One Instruction
105   ¦ finish_instruction:;
106   ¦ ++current_step_index();
107   }
108   stop_running_current_routine:;
109 }
110 :(before "End Globals")
111 bool Writing_products_of_instruction = false;
112 
113 :(code)
114 //: hook replaced in a later layer
115 bool should_continue_running(const routine* current_routine) {
116   assert(current_routine == Current_routine);  // argument passed in just to make caller readable above
117   return !Current_routine->completed();
118 }
119 
120 bool should_copy_ingredients() {
121   // End should_copy_ingredients Special-cases
122   return true;
123 }
124 
125 //: Some helpers.
126 //: Important that they return references into the current routine.
127 
128 //: hook replaced in a later layer
129 int& current_step_index() {
130   return Current_routine->running_step_index;
131 }
132 
133 //: hook replaced in a later layer
134 const string& current_recipe_name() {
135   return get(Recipe, Current_routine->running_recipe).name;
136 }
137 
138 //: hook replaced in a later layer
139 const recipe& current_recipe() {
140   return get(Recipe, Current_routine->running_recipe);
141 }
142 
143 //: hook replaced in a later layer
144 const instruction& current_instruction() {
145   return get(Recipe, Current_routine->running_recipe).steps.at(Current_routine->running_step_index);
146 }
147 
148 //: hook replaced in a later layer
149 bool routine::completed() const {
150   return running_step_index >= SIZE(get(Recipe, running_recipe).steps);
151 }
152 
153 //: hook replaced in a later layer
154 const vector<instruction>& routine::steps() const {
155   return get(Recipe, running_recipe).steps;
156 }
157 
158 //:: Startup flow
159 
160 //: Step 1: load all .mu files with numeric prefixes (in order)
161 :(before "End Load Recipes")
162 // Load Mu Prelude
163 //? Save_trace = true;
164 //? START_TRACING_UNTIL_END_OF_SCOPE;
165 load_file_or_directory("core.mu");
166 //? DUMP("");
167 //? exit(0);
168 
169 //: Step 2: load any .mu files provided at the commandline
170 :(before "End Commandline Parsing")
171 // Check For .mu Files
172 //? START_TRACING_UNTIL_END_OF_SCOPE
173 //? Dump_trace = true;
174 if (argc > 1) {
175   // skip argv[0]
176   ++argv;
177   --argc;
178   while (argc > 0) {
179   ¦ // ignore argv past '--'; that's commandline args for 'main'
180   ¦ if (string(*argv) == "--") break;
181   ¦ if (starts_with(*argv, "--"))
182   ¦ ¦ cerr << "treating " << *argv << " as a file rather than an option\n";
183   ¦ load_file_or_directory(*argv);
184   ¦ --argc;
185   ¦ ++argv;
186   }
187   if (Run_tests) Recipe.erase(get(Recipe_ordinal, "main"));
188 }
189 transform_all();
190 //? DUMP("");
191 //? exit(0);
192 if (trace_contains_errors()) return 1;
193 save_snapshots();
194 
195 //: Step 3: if we aren't running tests, locate a recipe called 'main' and
196 //: start running it.
197 :(before "End Main")
198 if (!Run_tests && contains_key(Recipe_ordinal, "main") && contains_key(Recipe, get(Recipe_ordinal, "main"))) {
199   // Running Main
200   setup();
201   if (Start_tracing) {
202   ¦ Trace_stream = new trace_stream;
203   ¦ Save_trace = true;
204   }
205   trace(2, "run") << "=== Starting to run" << end();
206   assert(Num_calls_to_transform_all == 1);
207   run_main(argc, argv);
208   teardown();
209 }
210 :(code)
211 void run_main(int argc, char* argv[]) {
212   recipe_ordinal r = get(Recipe_ordinal, "main");
213   if (r) run(r);
214 }
215 
216 //: By default we don't maintain the trace while running main because its
217 //: overheads can grow rapidly. However, it's useful when debugging.
218 :(before "End Globals")
219 bool Start_tracing = false;
220 :(before "End Commandline Options(*arg)")
221 else if (is_equal(*arg, "--trace")) {
222   Start_tracing = true;
223 }
224 
225 :(code)
226 void dump_profile() {
227   for (map<string, int>::iterator p = Instructions_running.begin();  p != Instructions_running.end();  ++p) {
228   ¦ cerr << p->first << ": " << p->second << '\n';
229   }
230   cerr << "== locations read\n";
231   for (map<string, int>::iterator p = Locations_read.begin();  p != Locations_read.end();  ++p) {
232   ¦ cerr << p->first << ": " << p->second << '\n';
233   }
234   cerr << "== locations read by instruction\n";
235   for (map<string, int>::iterator p = Locations_read_by_instruction.begin();  p != Locations_read_by_instruction.end();  ++p) {
236   ¦ cerr << p->first << ": " << p->second << '\n';
237   }
238 }
239 :(before "End One-time Setup")
240 //? atexit(dump_profile);
241 
242 :(code)
243 void cleanup_main() {
244   if (Save_trace && Trace_stream) {
245   ¦ cerr << "writing trace to 'last_run'\n";
246   ¦ ofstream fout("last_run");
247   ¦ fout << Trace_stream->readable_contents("");
248   ¦ fout.close();
249   }
250   if (Trace_stream) delete Trace_stream, Trace_stream = NULL;
251 }
252 :(before "End One-time Setup")
253 atexit(cleanup_main);
254 
255 :(code)
256 void load_file_or_directory(string filename) {
257   if (is_directory(filename)) {
258   ¦ load_all(filename);
259   ¦ return;
260   }
261   ifstream fin(filename.c_str());
262   if (!fin) {
263   ¦ cerr << "no such file '" << filename << "'\n" << end();  // don't raise, just warn. just in case it's just a name for a scenario to run.
264   ¦ return;
265   }
266   trace(9990, "load") << "=== " << filename << end();
267   load(fin);
268   fin.close();
269 }
270 
271 bool is_directory(string path) {
272   struct stat info;
273   if (stat(path.c_str(), &info)) return false;  // error
274   return info.st_mode & S_IFDIR;
275 }
276 
277 void load_all(string dir) {
278   dirent** files;
279   int num_files = scandir(dir.c_str(), &files, NULL, alphasort);
280   for (int i = 0;  i < num_files;  ++i) {
281   ¦ string curr_file = files[i]->d_name;
282   ¦ if (isdigit(curr_file.at(0)))
283   ¦ ¦ load_file_or_directory(dir+'/'+curr_file);
284   ¦ free(files[i]);
285   ¦ files[i] = NULL;
286   }
287   free(files);
288 }
289 :(before "End Includes")
290 #include <dirent.h>
291 #include <sys/stat.h>
292 
293 //:: Reading from memory, writing to memory.
294 
295 :(code)
296 vector<double> read_memory(reagent/*copy*/ x) {
297   // Begin Preprocess read_memory(x)
298   vector<double> result;
299   if (is_literal(x)) {
300   ¦ result.push_back(x.value);
301   ¦ return result;
302   }
303   // End Preprocess read_memory(x)
304   int size = size_of(x);
305   for (int offset = 0;  offset < size;  ++offset) {
306   ¦ double val = get_or_insert(Memory, x.value+offset);
307   ¦ trace(9999, "mem") << "location " << x.value+offset << " is " << no_scientific(val) << end();
308   ¦ result.push_back(val);
309   }
310   return result;
311 }
312 
313 void write_memory(reagent/*copy*/ x, const vector<double>& data) {
314   assert(Current_routine);  // run-time only
315   // Begin Preprocess write_memory(x, data)
316   if (!x.type) {
317   ¦ raise << "can't write to '" << to_string(x) << "'; no type\n" << end();
318   ¦ return;
319   }
320   if (is_dummy(x)) return;
321   if (is_literal(x)) return;
322   // End Preprocess write_memory(x, data)
323   if (x.value == 0) {
324   ¦ raise << "can't write to location 0 in '" << current_instruction().original_string << "'\n" << end();
325   ¦ return;
326   }
327   if (size_mismatch(x, data)) {
328   ¦ raise << maybe(current_recipe_name()) << "size mismatch in storing to '" << x.original_string << "' (" << size_of(x) << " vs " << SIZE(data) << ") at '" << current_instruction().original_string << "'\n" << end();
329   ¦ return;
330   }
331   // End write_memory(x) Special-cases
332   for (int offset = 0;  offset < SIZE(data);  ++offset) {
333   ¦ assert(x.value+offset > 0);
334   ¦ trace(9999, "mem") << "storing " << no_scientific(data.at(offset)) << " in location " << x.value+offset << end();
335   ¦ put(Memory, x.value+offset, data.at(offset));
336   }
337 }
338 
339 :(code)
340 int size_of(const reagent& r) {
341   if (!r.type) return 0;
342   // End size_of(reagent r) Special-cases
343   return size_of(r.type);
344 }
345 int size_of(const type_tree* type) {
346   if (!type) return 0;
347   if (type->atom) {
348   ¦ if (type->value == -1) return 1;  // error value, but we'll raise it elsewhere
349   ¦ if (type->value == 0) return 1;
350   ¦ // End size_of(type) Atom Special-cases
351   }
352   else {
353   ¦ if (!type->left->atom) {
354   ¦ ¦ raise << "invalid type " << to_string(type) << '\n' << end();
355   ¦ ¦ return 0;
356   ¦ }
357   ¦ if (type->left->value == get(Type_ordinal, "address")) return 1;
358   ¦ // End size_of(type) Non-atom Special-cases
359   }
360   // End size_of(type) Special-cases
361   return 1;
362 }
363 
364 bool size_mismatch(const reagent& x, const vector<double>& data) {
365   if (!x.type) return true;
366   // End size_mismatch(x) Special-cases
367 //?   if (size_of(x) != SIZE(data)) cerr << size_of(x) << " vs " << SIZE(data) << '\n';
368   return size_of(x) != SIZE(data);
369 }
370 
371 bool is_literal(const reagent& r) {
372   return is_literal(r.type);
373 }
374 bool is_literal(const type_tree* type) {
375   if (!type) return false;
376   if (!type->atom) return false;
377   return type->value == 0;
378 }
379 
380 bool scalar(const vector<int>& x) {
381   return SIZE(x) == 1;
382 }
383 bool scalar(const vector<double>& x) {
384   return SIZE(x) == 1;
385 }
386 
387 // helper for tests
388 void run(const string& form) {
389   vector<recipe_ordinal> tmp = load(form);
390   transform_all();
391   if (tmp.empty()) return;
392   if (trace_contains_errors()) return;
393   // if a test defines main, it probably wants to start there regardless of
394   // definition order
395   if (contains_key(Recipe, get(Recipe_ordinal, "main")))
396   ¦ run(get(Recipe_ordinal, "main"));
397   else
398   ¦ run(tmp.front());
399 }
400 
401 :(scenario run_label)
402 def main [
403   +foo
404   1:num <- copy 23
405   2:num <- copy 1:num
406 ]
407 +run: {1: "number"} <- copy {23: "literal"}
408 +run: {2: "number"} <- copy {1: "number"}
409 -run: +foo
410 
411 :(scenario run_dummy)
412 def main [
413   _ <- copy 0
414 ]
415 +run: _ <- copy {0: "literal"}
416 
417 :(scenario write_to_0_disallowed)
418 % Hide_errors = true;
419 def main [
420   0:num <- copy 34
421 ]
422 -mem: storing 34 in location 0
423 
424 //: Mu is robust to various combinations of commas and spaces. You just have
425 //: to put spaces around the '<-'.
426 
427 :(scenario comma_without_space)
428 def main [
429   1:num, 2:num <- copy 2,2
430 ]
431 +mem: storing 2 in location 1
432 
433 :(scenario space_without_comma)
434 def main [
435   1:num, 2:num <- copy 2 2
436 ]
437 +mem: storing 2 in location 1
438 
439 :(scenario comma_before_space)
440 def main [
441   1:num, 2:num <- copy 2, 2
442 ]
443 +mem: storing 2 in location 1
444 
445 :(scenario comma_after_space)
446 def main [
447   1:num, 2:num <- copy 2 ,2
448 ]
449 +mem: storing 2 in location 1