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