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