Implement step 7
[jackhill/mal.git] / Makefile
1 # Usage/help
2 all help:
3 @echo
4 @echo 'USAGE:'
5 @echo
6 @echo 'Rules/Targets:'
7 @echo
8 @echo 'make "IMPL" # build all steps of IMPL'
9 @echo 'make "IMPL^STEP" # build STEP of IMPL'
10 @echo
11 @echo 'make "test" # test all implementations'
12 @echo 'make "test^IMPL" # test all steps of IMPL'
13 @echo 'make "test^STEP" # test STEP for all implementations'
14 @echo 'make "test^IMPL^STEP" # test STEP of IMPL'
15 @echo
16 @echo 'make "perf" # run microbenchmarks for all implementations'
17 @echo 'make "perf^IMPL" # run microbenchmarks for IMPL'
18 @echo
19 @echo 'make "repl^IMPL" # run stepA of IMPL'
20 @echo 'make "repl^IMPL^STEP" # test STEP of IMPL'
21 @echo
22 @echo 'make "clean" # run 'make clean' for all implementations'
23 @echo 'make "clean^IMPL" # run 'make clean' for IMPL'
24 @echo
25 @echo 'make "stats" # run 'make stats' for all implementations'
26 @echo 'make "stats-lisp" # run 'make stats-lisp' for all implementations'
27 @echo 'make "stats^IMPL" # run 'make stats' for IMPL'
28 @echo 'make "stats-lisp^IMPL" # run 'make stats-lisp' for IMPL'
29 @echo
30 @echo 'Options/Settings:'
31 @echo
32 @echo 'make MAL_IMPL=IMPL "test^mal..." # use IMPL for self-host tests'
33 @echo 'make REGRESS=1 "test..." # test with previous step tests too'
34 @echo 'make DOCKERIZE=1 ... # to dockerize above rules/targets'
35 @echo
36 @echo 'Other:'
37 @echo
38 @echo 'make "docker-build^IMPL" # build docker image for IMPL'
39 @echo
40
41 #
42 # Command line settings
43 #
44
45 MAL_IMPL = js
46
47 PYTHON = python
48 USE_MATLAB =
49 # python, js, cpp, or neko are currently supported
50 HAXE_MODE = neko
51
52 # Extra options to pass to runtest.py
53 TEST_OPTS =
54
55 # Test with previous test files not just the test files for the
56 # current step. Step 0 and 1 tests are special and not included in
57 # later steps.
58 REGRESS =
59
60 # Extra implementation specific options to pass to runtest.py
61 mal_TEST_OPTS = --start-timeout 60 --test-timeout 120
62 miniMAL_TEST_OPTS = --start-timeout 60 --test-timeout 120
63
64 DOCKERIZE=
65
66 # Run target/rule within docker image for the implementation
67 DOCKERIZE =
68
69 #
70 # Settings
71 #
72
73 IMPLS = ada awk bash c d chuck clojure coffee cpp crystal cs erlang elisp \
74 elixir es6 factor forth fsharp go groovy guile haskell haxe \
75 io java julia js kotlin lua make mal ocaml matlab miniMAL \
76 nim objc objpascal perl php ps python r racket rpython ruby \
77 rust scala swift swift3 tcl vb vimscript
78
79 step0 = step0_repl
80 step1 = step1_read_print
81 step2 = step2_eval
82 step3 = step3_env
83 step4 = step4_if_fn_do
84 step5 = step5_tco
85 step6 = step6_file
86 step7 = step7_quote
87 step8 = step8_macros
88 step9 = step9_try
89 stepA = stepA_mal
90
91 regress_step0 = step0
92 regress_step1 = step1
93 regress_step2 = step2
94 regress_step3 = $(regress_step2) step3
95 regress_step4 = $(regress_step3) step4
96 regress_step5 = $(regress_step4) step5
97 regress_step6 = $(regress_step5) step6
98 regress_step7 = $(regress_step6) step7
99 regress_step8 = $(regress_step7) step8
100 regress_step9 = $(regress_step8) step9
101 regress_stepA = $(regress_step9) stepA
102
103 test_EXCLUDES += test^bash^step5 # never completes at 10,000
104 test_EXCLUDES += test^make^step5 # no TCO capability (iteration or recursion)
105 test_EXCLUDES += test^mal^step5 # host impl dependent
106 test_EXCLUDES += test^matlab^step5 # never completes at 10,000
107
108 perf_EXCLUDES = mal # TODO: fix this
109
110 dist_EXCLUDES += mal
111 # TODO: still need to implement dist
112 dist_EXCLUDES += guile io julia matlab swift
113
114 #
115 # Utility functions
116 #
117
118 MATLAB = matlab -nodisplay -nosplash -nodesktop -nojvm -r
119 OCTAVE = octave --no-gui -q --traditional --eval
120 matlab_args = $(subst $(SPACE),$(COMMA),$(foreach x,$(strip $(1)),'$(x)'))
121 matlab_cmd = $(if $(strip $(USE_MATLAB)),$(MATLAB),$(OCTAVE))
122
123 haxe_STEP_TO_PROG_neko = haxe/$($(1)).n
124 haxe_STEP_TO_PROG_python = haxe/$($(1)).py
125 haxe_STEP_TO_PROG_cpp = haxe/cpp/$($(1))
126 haxe_STEP_TO_PROG_js = haxe/$($(1)).js
127
128 haxe_RUNSTEP_neko = neko ../$(2) $(3)
129 haxe_RUNSTEP_python = python3 ../$(2) $(3)
130 haxe_RUNSTEP_cpp = ../$(2) $(3)
131 haxe_RUNSTEP_js = node ../$(2) $(3)
132
133 # Return list of test files for a given step. If REGRESS is set then
134 # test files will include step 2 tests through tests for the step
135 # being tested.
136 STEP_TEST_FILES = $(strip $(wildcard \
137 $(foreach s,$(if $(strip $(REGRESS)),$(regress_$(2)),$(2)),\
138 $(1)/tests/$($(s)).mal tests/$($(s)).mal)))
139
140 # Map of step (e.g. "step8") to executable file for that step
141 ada_STEP_TO_PROG = ada/$($(1))
142 awk_STEP_TO_PROG = awk/$($(1)).awk
143 bash_STEP_TO_PROG = bash/$($(1)).sh
144 c_STEP_TO_PROG = c/$($(1))
145 d_STEP_TO_PROG = d/$($(1))
146 chuck_STEP_TO_PROG = chuck/$($(1)).ck
147 clojure_STEP_TO_PROG = clojure/src/$($(1)).clj
148 coffee_STEP_TO_PROG = coffee/$($(1)).coffee
149 cpp_STEP_TO_PROG = cpp/$($(1))
150 crystal_STEP_TO_PROG = crystal/$($(1))
151 cs_STEP_TO_PROG = cs/$($(1)).exe
152 elisp_STEP_TO_PROG = elisp/$($(1)).el
153 elixir_STEP_TO_PROG = elixir/lib/mix/tasks/$($(1)).ex
154 erlang_STEP_TO_PROG = erlang/$($(1))
155 es6_STEP_TO_PROG = es6/build/$($(1)).js
156 factor_STEP_TO_PROG = factor/$($(1))/$($(1)).factor
157 forth_STEP_TO_PROG = forth/$($(1)).fs
158 fsharp_STEP_TO_PROG = fsharp/$($(1)).exe
159 go_STEP_TO_PROG = go/$($(1))
160 groovy_STEP_TO_PROG = groovy/$($(1)).groovy
161 java_STEP_TO_PROG = java/target/classes/mal/$($(1)).class
162 haskell_STEP_TO_PROG = haskell/$($(1))
163 haxe_STEP_TO_PROG = $(haxe_STEP_TO_PROG_$(HAXE_MODE))
164 io_STEP_TO_PROG = io/$($(1)).io
165 julia_STEP_TO_PROG = julia/$($(1)).jl
166 js_STEP_TO_PROG = js/$($(1)).js
167 kotlin_STEP_TO_PROG = kotlin/$($(1)).jar
168 lua_STEP_TO_PROG = lua/$($(1)).lua
169 make_STEP_TO_PROG = make/$($(1)).mk
170 mal_STEP_TO_PROG = mal/$($(1)).mal
171 ocaml_STEP_TO_PROG = ocaml/$($(1))
172 matlab_STEP_TO_PROG = matlab/$($(1)).m
173 miniMAL_STEP_TO_PROG = miniMAL/$($(1)).json
174 nim_STEP_TO_PROG = nim/$($(1))
175 objc_STEP_TO_PROG = objc/$($(1))
176 objpascal_STEP_TO_PROG = objpascal/$($(1))
177 perl_STEP_TO_PROG = perl/$($(1)).pl
178 php_STEP_TO_PROG = php/$($(1)).php
179 ps_STEP_TO_PROG = ps/$($(1)).ps
180 python_STEP_TO_PROG = python/$($(1)).py
181 r_STEP_TO_PROG = r/$($(1)).r
182 racket_STEP_TO_PROG = racket/$($(1)).rkt
183 rpython_STEP_TO_PROG = rpython/$($(1))
184 ruby_STEP_TO_PROG = ruby/$($(1)).rb
185 rust_STEP_TO_PROG = rust/target/release/$($(1))
186 scala_STEP_TO_PROG = scala/$($(1)).scala
187 swift_STEP_TO_PROG = swift/$($(1))
188 swift3_STEP_TO_PROG = swift3/$($(1))
189 tcl_STEP_TO_PROG = tcl/$($(1)).tcl
190 vb_STEP_TO_PROG = vb/$($(1)).exe
191 vimscript_STEP_TO_PROG = vimscript/$($(1)).vim
192 guile_STEP_TO_PROG = guile/$($(1)).scm
193
194
195 # Needed some argument munging
196 COMMA = ,
197 noop =
198 SPACE = $(noop) $(noop)
199 export FACTOR_ROOTS := .
200
201 # Macro for running a step:
202 # $(1): step (e.g. "stepA")
203 # $(2): program for step (e.g. result of *_STEP_TO_PROG
204 # $(3): program arguments
205 ada_RUNSTEP = ../$(2) $(3)
206 awk_RUNSTEP = awk -O -f ../$(2) $(3)
207 bash_RUNSTEP = bash ../$(2) $(3)
208 c_RUNSTEP = ../$(2) $(3)
209 d_RUNSTEP = ../$(2) $(3)
210 chuck_RUNSTEP = ./run_chuck.rb --silent ../$(2) $(3)
211 clojure_RUNSTEP = lein with-profile +$(1) trampoline run $(3)
212 coffee_RUNSTEP = coffee ../$(2) $(3)
213 cpp_RUNSTEP = ../$(2) $(3)
214 crystal_RUNSTEP = ../$(2) $(3)
215 cs_RUNSTEP = mono ../$(2) --raw $(3)
216 elisp_RUNSTEP = emacs -Q --batch --load ../$(2) $(3)
217 elixir_RUNSTEP = mix $(notdir $(basename $(2))) $(3)
218 erlang_RUNSTEP = ../$(2) $(3)
219 es6_RUNSTEP = node ../$(2) $(3)
220 factor_RUNSTEP = factor ../$(2) $(3)
221 forth_RUNSTEP = gforth ../$(2) $(3)
222 fsharp_RUNSTEP = mono ../$(2) --raw $(3)
223 go_RUNSTEP = ../$(2) $(3)
224 groovy_RUNSTEP = groovy ../$(2) $(3)
225 # needs TERM=dumb to work with readline
226 guile_RUNSTEP = guile --no-auto-compile -L ../guile ../$(2) $(3)
227 haskell_RUNSTEP = ../$(2) $(3)
228 haxe_RUNSTEP = python3 ../$(2) $(3)
229 haxe_RUNSTEP = $(haxe_RUNSTEP_$(HAXE_MODE))
230 io_RUNSTEP = io ../$(2) $(3)
231 java_RUNSTEP = mvn -quiet exec:java -Dexec.mainClass="mal.$($(1))" $(if $(3), -Dexec.args="$(3)",)
232 julia_RUNSTEP = ../$(2) $(3)
233 js_RUNSTEP = node ../$(2) $(3)
234 kotlin_RUNSTEP = java -jar ../$(2) $(3)
235 lua_RUNSTEP = ../$(2) $(3)
236 make_RUNSTEP = make -f ../$(2) $(3)
237 mal_RUNSTEP = $(call $(MAL_IMPL)_RUNSTEP,stepA,$(call $(MAL_IMPL)_STEP_TO_PROG,stepA),../$(2),") #"
238 ocaml_RUNSTEP = ../$(2) $(3)
239 matlab_RUNSTEP = $(matlab_cmd) "$($(1))($(call matlab_args,$(3)));quit;"
240 miniMAL_RUNSTEP = miniMAL ../$(2) $(3)
241 nim_RUNSTEP = ../$(2) $(3)
242 objc_RUNSTEP = ../$(2) $(3)
243 objpascal_RUNSTEP = ../$(2) $(3)
244 perl_RUNSTEP = perl ../$(2) $(3)
245 php_RUNSTEP = php ../$(2) $(3)
246 ps_RUNSTEP = gs -q -I./ -dNODISPLAY -- ../$(2) $(3)
247 python_RUNSTEP = $(PYTHON) ../$(2) $(3)
248 r_RUNSTEP = Rscript ../$(2) $(3)
249 racket_RUNSTEP = ../$(2) $(3)
250 rpython_RUNSTEP = ../$(2) $(3)
251 ruby_RUNSTEP = ruby ../$(2) $(3)
252 rust_RUNSTEP = ../$(2) $(3)
253 scala_RUNSTEP = sbt 'run-main $($(1))$(if $(3), $(3),)'
254 swift_RUNSTEP = ../$(2) $(3)
255 swift3_RUNSTEP = ../$(2) $(3)
256 tcl_RUNSTEP = tclsh ../$(2) --raw $(3)
257 vb_RUNSTEP = mono ../$(2) --raw $(3)
258 vimscript_RUNSTEP = ./run_vimscript.sh ../$(2) $(3)
259
260
261 # DOCKERIZE utility functions
262 lc = $(subst A,a,$(subst B,b,$(subst C,c,$(subst D,d,$(subst E,e,$(subst F,f,$(subst G,g,$(subst H,h,$(subst I,i,$(subst J,j,$(subst K,k,$(subst L,l,$(subst M,m,$(subst N,n,$(subst O,o,$(subst P,p,$(subst Q,q,$(subst R,r,$(subst S,s,$(subst T,t,$(subst U,u,$(subst V,v,$(subst W,w,$(subst X,x,$(subst Y,y,$(subst Z,z,$1))))))))))))))))))))))))))
263 impl_to_image = kanaka/mal-test-$(call lc,$(1))
264
265 actual_impl = $(if $(filter mal,$(1)),$(MAL_IMPL),$(1))
266
267 get_build_prefix = $(if $(strip $(DOCKERIZE)),docker run -it --rm -u $(shell id -u) -v $(dir $(abspath $(lastword $(MAKEFILE_LIST)))):/mal -w /mal/$(1) $(if $(filter factor,$(1)),-e FACTOR_ROOTS=$(FACTOR_ROOTS),) $(call impl_to_image,$(1)) ,)
268 get_run_prefix = $(if $(strip $(DOCKERIZE)),docker run -it --rm -u $(shell id -u) -v $(dir $(abspath $(lastword $(MAKEFILE_LIST)))):/mal -w /mal/$(call actual_impl,$(1)) $(if $(filter factor,$(1)),-e FACTOR_ROOTS=$(FACTOR_ROOTS),) $(call impl_to_image,$(call actual_impl,$(1))) ,)
269
270
271 vimscript_TEST_OPTS = --test-timeout 30
272 ifeq ($(MAL_IMPL),vimscript)
273 mal_TEST_OPTS = --start-timeout 60 --test-timeout 180
274 endif
275
276 # Derived lists
277 STEPS = $(sort $(filter step%,$(.VARIABLES)))
278 DO_IMPLS = $(filter-out $(SKIP_IMPLS),$(IMPLS))
279 IMPL_TESTS = $(foreach impl,$(DO_IMPLS),test^$(impl))
280 STEP_TESTS = $(foreach step,$(STEPS),test^$(step))
281 ALL_TESTS = $(filter-out $(test_EXCLUDES),\
282 $(strip $(sort \
283 $(foreach impl,$(DO_IMPLS),\
284 $(foreach step,$(STEPS),test^$(impl)^$(step))))))
285
286 DOCKER_BUILD = $(foreach impl,$(DO_IMPLS),docker-build^$(impl))
287
288 IMPL_PERF = $(foreach impl,$(filter-out $(perf_EXCLUDES),$(DO_IMPLS)),perf^$(impl))
289
290 IMPL_REPL = $(foreach impl,$(DO_IMPLS),repl^$(impl))
291 ALL_REPL = $(strip $(sort \
292 $(foreach impl,$(DO_IMPLS),\
293 $(foreach step,$(STEPS),repl^$(impl)^$(step)))))
294
295 #
296 # Build rules
297 #
298
299 # Build a program in an implementation directory
300 # Make sure we always try and build first because the dependencies are
301 # encoded in the implementation Makefile not here
302 .PHONY: $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(call $(i)_STEP_TO_PROG,$(s))))
303 $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(call $(i)_STEP_TO_PROG,$(s)))):
304 $(foreach impl,$(word 1,$(subst /, ,$(@))),\
305 $(if $(DOCKERIZE), \
306 $(call get_build_prefix,$(impl))$(MAKE) $(patsubst $(impl)/%,%,$(@)), \
307 $(MAKE) -C $(impl) $(subst $(impl)/,,$(@))))
308
309 # Allow IMPL, and IMPL^STEP
310 .SECONDEXPANSION:
311 $(DO_IMPLS): $$(foreach s,$$(STEPS),$$(call $$(@)_STEP_TO_PROG,$$(s)))
312
313 .SECONDEXPANSION:
314 $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(i)^$(s))): $$(call $$(word 1,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 2,$$(subst ^, ,$$(@))))
315
316
317 #
318 # Test rules
319 #
320
321 .SECONDEXPANSION:
322 $(ALL_TESTS): $$(call $$(word 2,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 3,$$(subst ^, ,$$(@))))
323 @$(foreach impl,$(word 2,$(subst ^, ,$(@))),\
324 $(foreach step,$(word 3,$(subst ^, ,$(@))),\
325 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)) && \
326 $(foreach test,$(call STEP_TEST_FILES,$(impl),$(step)),\
327 echo '----------------------------------------------' && \
328 echo 'Testing $@, step file: $+, test file: $(test)' && \
329 echo 'Running: $(call get_run_prefix,$(impl))../runtest.py $(TEST_OPTS) $(call $(impl)_TEST_OPTS) ../$(test) -- $(call $(impl)_RUNSTEP,$(step),$(+))' && \
330 $(call get_run_prefix,$(impl))../runtest.py $(TEST_OPTS) $(call $(impl)_TEST_OPTS) ../$(test) -- $(call $(impl)_RUNSTEP,$(step),$(+)) &&) \
331 true))
332
333 # Allow test, tests, test^STEP, test^IMPL, and test^IMPL^STEP
334 test: $(ALL_TESTS)
335 tests: $(ALL_TESTS)
336
337 .SECONDEXPANSION:
338 $(IMPL_TESTS): $$(filter $$@^%,$$(ALL_TESTS))
339
340 .SECONDEXPANSION:
341 $(STEP_TESTS): $$(foreach step,$$(subst test^,,$$@),$$(filter %^$$(step),$$(ALL_TESTS)))
342
343
344 #
345 # Dist rules
346 #
347
348 dist: $(IMPL_DIST)
349
350 .SECONDEXPANSION:
351 $(IMPL_DIST):
352 @echo "----------------------------------------------"; \
353 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
354 echo "Running: make -C $(impl) dist"; \
355 $(MAKE) --no-print-directory -C $(impl) dist)
356
357
358 #
359 # Docker build rules
360 #
361
362 docker-build: $(DOCKER_BUILD)
363
364 .SECONDEXPANSION:
365 $(DOCKER_BUILD):
366 echo "----------------------------------------------"; \
367 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
368 echo "Running: docker build -t $(call impl_to_image,$(impl)) .:"; \
369 cd $(impl) && docker build -t $(call impl_to_image,$(impl)) .)
370
371
372 #
373 # Performance test rules
374 #
375
376 perf: $(IMPL_PERF)
377
378 .SECONDEXPANSION:
379 $(IMPL_PERF):
380 @echo "----------------------------------------------"; \
381 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
382 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)); \
383 echo "Performance test for $(impl):"; \
384 echo 'Running: $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf1.mal)'; \
385 $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf1.mal); \
386 echo 'Running: $(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf2.mal)'; \
387 $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf2.mal); \
388 echo 'Running: $(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf3.mal)'; \
389 $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,stepA,$(call $(impl)_STEP_TO_PROG,stepA),../tests/perf3.mal))
390
391
392 #
393 # REPL invocation rules
394 #
395
396 .SECONDEXPANSION:
397 $(ALL_REPL): $$(call $$(word 2,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 3,$$(subst ^, ,$$(@))))
398 @$(foreach impl,$(word 2,$(subst ^, ,$(@))),\
399 $(foreach step,$(word 3,$(subst ^, ,$(@))),\
400 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)); \
401 echo 'REPL implementation $(impl), step file: $+'; \
402 echo 'Running: $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,$(step),$(+))'; \
403 $(call get_run_prefix,$(impl))$(call $(impl)_RUNSTEP,$(step),$(+));))
404
405 # Allow repl^IMPL^STEP and repl^IMPL (which starts REPL of stepA)
406 .SECONDEXPANSION:
407 $(IMPL_REPL): $$@^stepA
408
409 #
410 # Utility functions
411 #
412 .SECONDEXPANSION:
413 print-%:
414 @echo "$($(*))"
415
416 #
417 # Recursive rules (call make FOO in each subdirectory)
418 #
419
420 define recur_template
421 .PHONY: $(1)
422 $(1): $(2)
423 .SECONDEXPANSION:
424 $(2):
425 @echo "----------------------------------------------"; \
426 $$(foreach impl,$$(word 2,$$(subst ^, ,$$(@))),\
427 $$(if $$(DOCKERIZE), \
428 echo "Running: $$(call get_build_prefix,$$(impl))$$(MAKE) --no-print-directory $(1)"; \
429 $$(call get_build_prefix,$$(impl))$$(MAKE) --no-print-directory $(1), \
430 echo "Running: $$(MAKE) --no-print-directory -C $$(impl) $(1)"; \
431 $$(MAKE) --no-print-directory -C $$(impl) $(1)))
432 endef
433
434 recur_impls_ = $(filter-out $(foreach impl,$($(1)_EXCLUDES),$(1)^$(impl)),$(foreach impl,$(IMPLS),$(1)^$(impl)))
435
436 # recursive clean
437 $(eval $(call recur_template,clean,$(call recur_impls_,clean)))
438
439 # recursive stats
440 $(eval $(call recur_template,stats,$(call recur_impls_,stats)))
441 $(eval $(call recur_template,stats-lisp,$(call recur_impls_,stats-lisp)))
442
443 # recursive dist
444 $(eval $(call recur_template,dist,$(call recur_impls_,dist)))