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