Merge pull request #262 from c0deaddict/master
[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 # clj or cljs are currently supported (Clojure vs ClojureScript/lumo)
52 CLJ_MODE = clj
53
54 # Extra options to pass to runtest.py
55 TEST_OPTS =
56
57 # Test with previous test files not just the test files for the
58 # current step. Step 0 and 1 tests are special and not included in
59 # later steps.
60 REGRESS =
61
62 DEFERRABLE=1
63 OPTIONAL=1
64
65 # Extra implementation specific options to pass to runtest.py
66 logo_TEST_OPTS = --start-timeout 60 --test-timeout 120
67 mal_TEST_OPTS = --start-timeout 60 --test-timeout 120
68 miniMAL_TEST_OPTS = --start-timeout 60 --test-timeout 120
69 plpgsql_TEST_OPTS = --start-timeout 60 --test-timeout 180
70 plsql_TEST_OPTS = --start-timeout 120 --test-timeout 120
71 perl6_TEST_OPTS = --test-timeout=60
72
73 # Run target/rule within docker image for the implementation
74 DOCKERIZE =
75
76 #
77 # Settings
78 #
79
80 IMPLS = ada awk bash basic c d chuck clojure coffee common-lisp cpp crystal cs dart \
81 erlang elisp elixir es6 factor forth fsharp go groovy guile haskell \
82 haxe io java julia js kotlin logo lua make mal ocaml matlab miniMAL \
83 nim objc objpascal perl perl6 php pil plpgsql plsql powershell ps \
84 python r racket rpython ruby rust scala skew swift swift3 tcl ts vb vhdl \
85 vimscript livescript
86
87 EXTENSION = .mal
88
89 step0 = step0_repl
90 step1 = step1_read_print
91 step2 = step2_eval
92 step3 = step3_env
93 step4 = step4_if_fn_do
94 step5 = step5_tco
95 step6 = step6_file
96 step7 = step7_quote
97 step8 = step8_macros
98 step9 = step9_try
99 stepA = stepA_mal
100
101 argv_STEP = step6_file
102
103
104 regress_step0 = step0
105 regress_step1 = step1
106 regress_step2 = step2
107 regress_step3 = $(regress_step2) step3
108 regress_step4 = $(regress_step3) step4
109 regress_step5 = $(regress_step4) step5
110 regress_step6 = $(regress_step5) step6
111 regress_step7 = $(regress_step6) step7
112 regress_step8 = $(regress_step7) step8
113 regress_step9 = $(regress_step8) step9
114 regress_stepA = $(regress_step9) stepA
115
116 test_EXCLUDES += test^bash^step5 # never completes at 10,000
117 test_EXCLUDES += test^basic^step5 # too slow, and limited to ints of 2^16
118 test_EXCLUDES += test^logo^step5 # too slow for 10,000
119 test_EXCLUDES += test^make^step5 # no TCO capability (iteration or recursion)
120 test_EXCLUDES += test^mal^step5 # host impl dependent
121 test_EXCLUDES += test^matlab^step5 # never completes at 10,000
122 test_EXCLUDES += test^plpgsql^step5 # too slow for 10,000
123 test_EXCLUDES += test^plsql^step5 # too slow for 10,000
124 test_EXCLUDES += test^powershell^step5 # too slow for 10,000
125
126 perf_EXCLUDES = mal # TODO: fix this
127
128 dist_EXCLUDES += mal
129 # TODO: still need to implement dist
130 dist_EXCLUDES += guile io julia matlab swift
131
132 #
133 # Utility functions
134 #
135
136 haxe_STEP_TO_PROG_neko = haxe/$($(1)).n
137 haxe_STEP_TO_PROG_python = haxe/$($(1)).py
138 haxe_STEP_TO_PROG_cpp = haxe/cpp/$($(1))
139 haxe_STEP_TO_PROG_js = haxe/$($(1)).js
140
141 clojure_STEP_TO_PROG_clj = clojure/target/$($(1)).jar
142 clojure_STEP_TO_PROG_cljs = clojure/src/mal/$($(1)).cljc
143
144 opt_DEFERRABLE = $(if $(strip $(DEFERRABLE)),$(if $(filter t true T True TRUE 1 y yes Yes YES,$(DEFERRABLE)),--deferrable,--no-deferrable),--no-deferrable)
145 opt_OPTIONAL = $(if $(strip $(OPTIONAL)),$(if $(filter t true T True TRUE 1 y yes Yes YES,$(OPTIONAL)),--optional,--no-optional),--no-optional)
146
147 # Return list of test files for a given step. If REGRESS is set then
148 # test files will include step 2 tests through tests for the step
149 # being tested.
150 STEP_TEST_FILES = $(strip $(wildcard \
151 $(foreach s,$(if $(strip $(REGRESS)),$(regress_$(2)),$(2)),\
152 $(1)/tests/$($(s))$(EXTENSION) tests/$($(s))$(EXTENSION))))
153
154 # Map of step (e.g. "step8") to executable file for that step
155 ada_STEP_TO_PROG = ada/$($(1))
156 awk_STEP_TO_PROG = awk/$($(1)).awk
157 bash_STEP_TO_PROG = bash/$($(1)).sh
158 basic_STEP_TO_PROG = basic/$($(1)).bas
159 c_STEP_TO_PROG = c/$($(1))
160 d_STEP_TO_PROG = d/$($(1))
161 chuck_STEP_TO_PROG = chuck/$($(1)).ck
162 clojure_STEP_TO_PROG = $(clojure_STEP_TO_PROG_$(CLJ_MODE))
163 coffee_STEP_TO_PROG = coffee/$($(1)).coffee
164 common-lisp_STEP_TO_PROG = common-lisp/$($(1))
165 cpp_STEP_TO_PROG = cpp/$($(1))
166 crystal_STEP_TO_PROG = crystal/$($(1))
167 cs_STEP_TO_PROG = cs/$($(1)).exe
168 dart_STEP_TO_PROG = dart/$($(1)).dart
169 elisp_STEP_TO_PROG = elisp/$($(1)).el
170 elixir_STEP_TO_PROG = elixir/lib/mix/tasks/$($(1)).ex
171 erlang_STEP_TO_PROG = erlang/$($(1))
172 es6_STEP_TO_PROG = es6/build/$($(1)).js
173 factor_STEP_TO_PROG = factor/$($(1))/$($(1)).factor
174 forth_STEP_TO_PROG = forth/$($(1)).fs
175 fsharp_STEP_TO_PROG = fsharp/$($(1)).exe
176 go_STEP_TO_PROG = go/$($(1))
177 groovy_STEP_TO_PROG = groovy/$($(1)).groovy
178 java_STEP_TO_PROG = java/target/classes/mal/$($(1)).class
179 haskell_STEP_TO_PROG = haskell/$($(1))
180 haxe_STEP_TO_PROG = $(haxe_STEP_TO_PROG_$(HAXE_MODE))
181 io_STEP_TO_PROG = io/$($(1)).io
182 julia_STEP_TO_PROG = julia/$($(1)).jl
183 js_STEP_TO_PROG = js/$($(1)).js
184 kotlin_STEP_TO_PROG = kotlin/$($(1)).jar
185 lua_STEP_TO_PROG = lua/$($(1)).lua
186 make_STEP_TO_PROG = make/$($(1)).mk
187 mal_STEP_TO_PROG = mal/$($(1)).mal
188 ocaml_STEP_TO_PROG = ocaml/$($(1))
189 matlab_STEP_TO_PROG = matlab/$($(1)).m
190 miniMAL_STEP_TO_PROG = miniMAL/$($(1)).json
191 nim_STEP_TO_PROG = nim/$($(1))
192 objc_STEP_TO_PROG = objc/$($(1))
193 objpascal_STEP_TO_PROG = objpascal/$($(1))
194 perl_STEP_TO_PROG = perl/$($(1)).pl
195 perl6_STEP_TO_PROG = perl6/$($(1)).pl
196 php_STEP_TO_PROG = php/$($(1)).php
197 pil_STEP_TO_PROG = pil/$($(1)).l
198 plpgsql_STEP_TO_PROG = plpgsql/$($(1)).sql
199 plsql_STEP_TO_PROG = plsql/$($(1)).sql
200 powershell_STEP_TO_PROG = powershell/$($(1)).ps1
201 ps_STEP_TO_PROG = ps/$($(1)).ps
202 python_STEP_TO_PROG = python/$($(1)).py
203 r_STEP_TO_PROG = r/$($(1)).r
204 racket_STEP_TO_PROG = racket/$($(1)).rkt
205 rpython_STEP_TO_PROG = rpython/$($(1))
206 ruby_STEP_TO_PROG = ruby/$($(1)).rb
207 rust_STEP_TO_PROG = rust/target/release/$($(1))
208 scala_STEP_TO_PROG = scala/target/scala-2.11/classes/$($(1)).class
209 skew_STEP_TO_PROG = skew/$($(1)).js
210 swift_STEP_TO_PROG = swift/$($(1))
211 swift3_STEP_TO_PROG = swift3/$($(1))
212 tcl_STEP_TO_PROG = tcl/$($(1)).tcl
213 ts_STEP_TO_PROG = ts/$($(1)).js
214 vb_STEP_TO_PROG = vb/$($(1)).exe
215 vhdl_STEP_TO_PROG = vhdl/$($(1))
216 vimscript_STEP_TO_PROG = vimscript/$($(1)).vim
217 guile_STEP_TO_PROG = guile/$($(1)).scm
218 livescript_STEP_TO_PROG = livescript/$($(1)).js
219
220
221 # Needed some argument munging
222 COMMA = ,
223 noop =
224 SPACE = $(noop) $(noop)
225 export FACTOR_ROOTS := .
226
227 # DOCKERIZE utility functions
228 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))))))))))))))))))))))))))
229 impl_to_image = kanaka/mal-test-$(call lc,$(1))
230
231 actual_impl = $(if $(filter mal,$(1)),$(MAL_IMPL),$(1))
232
233 # Takes impl
234 # Returns nothing if DOCKERIZE is not set, otherwise returns the
235 # docker prefix necessary to run make within the docker environment
236 # for this impl
237 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)) ,)
238
239 # Takes impl and step arguments
240 # Returns a command prefix (docker command and environment variables)
241 # necessary to launch the given impl and step
242 get_run_prefix = $(strip $(if $(strip $(DOCKERIZE)),\
243 docker run -e STEP=$($2) -e MAL_IMPL=$(MAL_IMPL) \
244 -it --rm -u $(shell id -u) \
245 -v $(dir $(abspath $(lastword $(MAKEFILE_LIST)))):/mal \
246 -w /mal/$(call actual_impl,$(1)) \
247 $(if $(filter clojure,$(1)),-e CLJ_MODE=$(CLJ_MODE),) \
248 $(if $(filter haxe,$(1)),-e HAXE_MODE=$(HAXE_MODE),) \
249 $(if $(filter factor,$(1)),-e FACTOR_ROOTS=$(FACTOR_ROOTS),) \
250 $(foreach env,$(3),-e $(env)) \
251 $(call impl_to_image,$(call actual_impl,$(1))) \
252 ,\
253 env STEP=$($2) MAL_IMPL=$(MAL_IMPL) \
254 $(if $(filter haxe,$(1)),HAXE_MODE=$(HAXE_MODE),) \
255 $(if $(filter factor,$(1)),FACTOR_ROOTS=$(FACTOR_ROOTS),) \
256 $(3)))
257
258 # Takes impl and step
259 # Returns the runtest command prefix (with runtest options) for testing the given step
260 get_runtest_cmd = $(call get_run_prefix,$(1),$(2),$(if $(filter cs fsharp tcl vb,$(1)),RAW=1,)) \
261 ../runtest.py $(opt_DEFERRABLE) $(opt_OPTIONAL) $(call $(1)_TEST_OPTS) $(TEST_OPTS)
262
263 # Takes impl and step
264 # Returns the runtest command prefix (with runtest options) for testing the given step
265 get_argvtest_cmd = $(call get_run_prefix,$(1),$(2)) ../run_argv_test.sh
266
267 vimscript_TEST_OPTS = --test-timeout 30
268 ifeq ($(MAL_IMPL),vimscript)
269 mal_TEST_OPTS = --start-timeout 60 --test-timeout 180
270 else ifeq ($(MAL_IMPL),powershell)
271 mal_TEST_OPTS = --start-timeout 60 --test-timeout 180
272 endif
273
274 # Derived lists
275 STEPS = $(sort $(filter step%,$(.VARIABLES)))
276 DO_IMPLS = $(filter-out $(SKIP_IMPLS),$(IMPLS))
277 IMPL_TESTS = $(foreach impl,$(DO_IMPLS),test^$(impl))
278 STEP_TESTS = $(foreach step,$(STEPS),test^$(step))
279 ALL_TESTS = $(filter-out $(test_EXCLUDES),\
280 $(strip $(sort \
281 $(foreach impl,$(DO_IMPLS),\
282 $(foreach step,$(STEPS),test^$(impl)^$(step))))))
283
284 DOCKER_BUILD = $(foreach impl,$(DO_IMPLS),docker-build^$(impl))
285
286 IMPL_PERF = $(foreach impl,$(filter-out $(perf_EXCLUDES),$(DO_IMPLS)),perf^$(impl))
287
288 IMPL_REPL = $(foreach impl,$(DO_IMPLS),repl^$(impl))
289 ALL_REPL = $(strip $(sort \
290 $(foreach impl,$(DO_IMPLS),\
291 $(foreach step,$(STEPS),repl^$(impl)^$(step)))))
292
293 #
294 # Build rules
295 #
296
297 # Build a program in an implementation directory
298 # Make sure we always try and build first because the dependencies are
299 # encoded in the implementation Makefile not here
300 .PHONY: $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(call $(i)_STEP_TO_PROG,$(s))))
301 $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(call $(i)_STEP_TO_PROG,$(s)))):
302 $(foreach impl,$(word 1,$(subst /, ,$(@))),\
303 $(if $(DOCKERIZE), \
304 $(call get_build_prefix,$(impl))$(MAKE) $(patsubst $(impl)/%,%,$(@)), \
305 $(MAKE) -C $(impl) $(subst $(impl)/,,$(@))))
306
307 # Allow IMPL, and IMPL^STEP
308 .SECONDEXPANSION:
309 $(DO_IMPLS): $$(foreach s,$$(STEPS),$$(call $$(@)_STEP_TO_PROG,$$(s)))
310
311 .SECONDEXPANSION:
312 $(foreach i,$(DO_IMPLS),$(foreach s,$(STEPS),$(i)^$(s))): $$(call $$(word 1,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 2,$$(subst ^, ,$$(@))))
313
314
315 #
316 # Test rules
317 #
318
319 .SECONDEXPANSION:
320 $(ALL_TESTS): $$(call $$(word 2,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 3,$$(subst ^, ,$$(@))))
321 @$(foreach impl,$(word 2,$(subst ^, ,$(@))),\
322 $(foreach step,$(word 3,$(subst ^, ,$(@))),\
323 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)) && \
324 $(foreach test,$(call STEP_TEST_FILES,$(impl),$(step)),\
325 echo '----------------------------------------------' && \
326 echo 'Testing $@; step file: $+, test file: $(test)' && \
327 echo 'Running: $(call get_runtest_cmd,$(impl),$(step)) ../$(test) -- ../$(impl)/run' && \
328 $(call get_runtest_cmd,$(impl),$(step)) ../$(test) -- ../$(impl)/run && \
329 $(if $(filter tests/$(argv_STEP)$(EXTENSION),$(test)),\
330 echo '----------------------------------------------' && \
331 echo 'Testing ARGV of $@; step file: $+' && \
332 echo 'Running: $(call get_argvtest_cmd,$(impl),$(step)) ../$(impl)/run ' && \
333 $(call get_argvtest_cmd,$(impl),$(step)) ../$(impl)/run && ,\
334 true && ))\
335 true))
336
337 # Allow test, tests, test^STEP, test^IMPL, and test^IMPL^STEP
338 test: $(ALL_TESTS)
339 tests: $(ALL_TESTS)
340
341 .SECONDEXPANSION:
342 $(IMPL_TESTS): $$(filter $$@^%,$$(ALL_TESTS))
343
344 .SECONDEXPANSION:
345 $(STEP_TESTS): $$(foreach step,$$(subst test^,,$$@),$$(filter %^$$(step),$$(ALL_TESTS)))
346
347
348 #
349 # Dist rules
350 #
351
352 dist: $(IMPL_DIST)
353
354 .SECONDEXPANSION:
355 $(IMPL_DIST):
356 @echo "----------------------------------------------"; \
357 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
358 echo "Running: make -C $(impl) dist"; \
359 $(MAKE) --no-print-directory -C $(impl) dist)
360
361
362 #
363 # Docker build rules
364 #
365
366 docker-build: $(DOCKER_BUILD)
367
368 .SECONDEXPANSION:
369 $(DOCKER_BUILD):
370 echo "----------------------------------------------"; \
371 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
372 echo "Running: docker build -t $(call impl_to_image,$(impl)) .:"; \
373 cd $(impl) && docker build -t $(call impl_to_image,$(impl)) .)
374
375
376 #
377 # Performance test rules
378 #
379
380 perf: $(IMPL_PERF)
381
382 .SECONDEXPANSION:
383 $(IMPL_PERF):
384 @echo "----------------------------------------------"; \
385 $(foreach impl,$(word 2,$(subst ^, ,$(@))),\
386 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)); \
387 echo "Performance test for $(impl):"; \
388 echo 'Running: $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf1.mal'; \
389 $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf1.mal; \
390 echo 'Running: $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf2.mal'; \
391 $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf2.mal; \
392 echo 'Running: $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf3.mal'; \
393 $(call get_run_prefix,$(impl),stepA) ../$(impl)/run ../tests/perf3.mal)
394
395
396 #
397 # REPL invocation rules
398 #
399
400 .SECONDEXPANSION:
401 $(ALL_REPL): $$(call $$(word 2,$$(subst ^, ,$$(@)))_STEP_TO_PROG,$$(word 3,$$(subst ^, ,$$(@))))
402 @$(foreach impl,$(word 2,$(subst ^, ,$(@))),\
403 $(foreach step,$(word 3,$(subst ^, ,$(@))),\
404 cd $(if $(filter mal,$(impl)),$(MAL_IMPL),$(impl)); \
405 echo 'REPL implementation $(impl), step file: $+'; \
406 echo 'Running: $(call get_run_prefix,$(impl),$(step)) ../$(impl)/run'; \
407 $(call get_run_prefix,$(impl),$(step)) ../$(impl)/run;))
408
409 # Allow repl^IMPL^STEP and repl^IMPL (which starts REPL of stepA)
410 .SECONDEXPANSION:
411 $(IMPL_REPL): $$@^stepA
412
413 #
414 # Utility functions
415 #
416 .SECONDEXPANSION:
417 print-%:
418 @echo "$($(*))"
419
420 #
421 # Recursive rules (call make FOO in each subdirectory)
422 #
423
424 define recur_template
425 .PHONY: $(1)
426 $(1): $(2)
427 .SECONDEXPANSION:
428 $(2):
429 @echo "----------------------------------------------"; \
430 $$(foreach impl,$$(word 2,$$(subst ^, ,$$(@))),\
431 $$(if $$(DOCKERIZE), \
432 echo "Running: $$(call get_build_prefix,$$(impl))$$(MAKE) --no-print-directory $(1)"; \
433 $$(call get_build_prefix,$$(impl))$$(MAKE) --no-print-directory $(1), \
434 echo "Running: $$(MAKE) --no-print-directory -C $$(impl) $(1)"; \
435 $$(MAKE) --no-print-directory -C $$(impl) $(1)))
436 endef
437
438 recur_impls_ = $(filter-out $(foreach impl,$($(1)_EXCLUDES),$(1)^$(impl)),$(foreach impl,$(IMPLS),$(1)^$(impl)))
439
440 # recursive clean
441 $(eval $(call recur_template,clean,$(call recur_impls_,clean)))
442
443 # recursive stats
444 $(eval $(call recur_template,stats,$(call recur_impls_,stats)))
445 $(eval $(call recur_template,stats-lisp,$(call recur_impls_,stats-lisp)))
446
447 # recursive dist
448 $(eval $(call recur_template,dist,$(call recur_impls_,dist)))