spec-driven-workshop/Makefile at main · adzerk/spec-driven-workshop · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

include Makefile.preamble

# Tools/Executables
# ---------------------------------------------------------------
# None

# Vars/Settings
# ---------------------------------------------------------------
JVM_MEM ?=1G
JVM_FLAGS ?= -Xms $(JVM_MEM) -Xmx $(JVM_MEM) -XX:+UseNUMA -XX:+AlwaysPreTouch
# -XX:+UseStringCache -XX:+OptimizeStringConcat

RUN_JAR_ARGS ?= -jar -Dfile.encoding=UTF-8
UBERJAR_PATH = target/spec-driven-demo-1.0.0-SNAPSHOT.jar

java_sources = $(shell if [ -d ./src/main ]; then find ./src/main -type f -name '*.java'; fi)

ifeq ($(shell uname -s),Linux)
	# you might also want:
	# -rf json
	# -rff my-bench-results.json
	#JMH_ARGS ?= -prof comp -prof gc -prof perf
	JMH_ARGS ?= -prof comp -prof gc -prof perf ".*Tap.*Thru.*"
else
	# Assumes MacOS/OSX
	JMH_ARGS ?= -prof comp -prof gc
	#JMH_ARGS ?= -prof comp -prof gc -prof dtraceasm ".*Pedestal.*Thru.*"
endif

## Dumping ground // Notes
## --------------------------------
#

# This captures all the arguments after `make TARGET` allowing you to pass them as args to something else
# Note: This doesn't work as expected if someone types multiple targets `make TARG1 TARG2 ...`
XTRA_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))

.DEFAULT_GOAL := check

# Notes on tooling:
# ESW ensures stable platform version, independent of systems/local machine setups/etc.
# In this respect, all necessary "tooling" is built for use within a project - a JDK version, Clojure tooling, etc.
# and the tooling is confirmed via a series of checksums.
# The Clojure tooling is a series of Bash scripts written by the Clojure.core team directly.
# These scripts are expected to be installed via a package management tool, as a system-level install.
# The scripts do not resolve binaries via `env`, only uses the system PATH directly, and do not respect common JVM environment variables.
# This creates a situation in which the Clojure tooling cannot be told to use our 'tooling' JVM -- it will only ever use a system-level JVM install.
# `sed` is used to update the Clojure tooling scripts to use env, respect local PATH settings, and respect some JVM envvars.
# The 'Darwin' `sed` approach follows a POSIX spec, forcing a newline after the '2i\' expression.  The newline is injected via sed/Bash escaping.

tooling:
	$(MAKE) $(join tooling_,$(shell uname -s))

.PHONY : repl
repl:
	@JAVA_HOME=$(JHOME) $(MVN) -P dev clojure:repl

.PHONY : jshell
jshell:
	@JAVA_HOME=$(JHOME) $(MVN) -P dev jshell:run

.PHONY : format
format:
	@JAVA_HOME=$(JHOME) $(MVN) spotless:apply

.PHONY : check
check: format
	@JAVA_HOME=$(JHOME) $(MVN) -P errorprone verify

.PHONY : test
test:
	@JAVA_HOME=$(JHOME) $(MVN) test

.PHONY : check-jml-only
check-jml-only:
	@tooling/openjml/openjml --esc --progress -cp $(shell mvn dependency:build-classpath -Dmdep.outputFile=/dev/stdout -q) --dirs src/main
	# This next line works too, leaving it as an example
	#@tooling/openjml/openjml --esc --progress -cp $(shell mvn dependency:build-classpath -Dmdep.outputFile=/dev/stdout -q) $(java_sources)
	#TODO Needs args in the correct position via compiler or exec plugin, which is why we're calling it directly ^^
	#@mvn -P openjml -e -X verify

.PHONY : check-jml
check-jml: check check-jml-only

.PHONY : doc
doc:
	@JAVA_HOME=$(JHOME) $(MVN) javadoc:javadoc

.PHONY : uberjar
uberjar:
	@JAVA_HOME=$(JHOME) $(MVN) package

.PHONY : run
run:
	@$(JAVA) $(RUN_JAR_ARGS) $(UBERJAR_PATH)

.PHONY : clean
clean:
	@JAVA_HOME=$(JHOME) $(MVN) clean

#.PHONY : prep-env
#prep-env:
#	@echo "Ensuring the existance of $(JVM_MEM) worth of huge/large pages"
#	#echo 512 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages #512 per 1G, you shouls also enable an additional 1-2G for non-Java heap allocations
#	#echo 512 > /proc/sys/vm/nr_hugepages #assumes /proc/meminfo says Hugepagesize if 2048 kB
#	#echo "vm.nr_hugepages=512" >> /etc/sysctl.conf # If we want to ensure the pages are always on boot set via sysctl
#	sysctl vm.nr_hugepages=512
#	@echo "Pushing CPU govenors into performance mode"
#	cpufreq-set -r -g performance # For Debian.  If you're on a RH-derived OS, this is most likely cpupower frequency-set -g performance
#	@echo "Turn down swappiness"
#	sysctl vm.swappiness=10
#	@echo "Turn up max files / open files"
#	sysctl fs.file-max=2097152 # Global - Somewhere between 1048576-2097152 is good, check /proc/sys/fs/nr_open and /proc/sys/fs/file-nr to see settings and relative maxes
#	sysctl fs.nr_open=1048576 # Max num of file-handler per-process.
#	@echo "Disabling TCP Slow-start at the OS level"
#	sysctl net.ipv4.tcp_slow_start_after_idle=0
#	@echo "Ensuring TCP is using the BBR congestion algo and Fair Queueing"
#	sysctl net.ipv4.tcp_congestion_control=bbr
#	sysctl net.core.default_qdisc=fq
#	@echo "Expanding TCP buffer sizes; Be cautious of buffer bloat"
#	sysctl net.ipv4.tcp_notsent_lowat=16384 # 16K of additional buffer over cong window; at most 16K of lower-priority data will be buffered before a higher pri can interrupt it
#	sysctl net.ipv4.tcp_rmem='4096 87380 33554432' # TCP autotuning read-buffer MIN DEFAULT MAX=32MB; Max allowed in Linux is 2Gb - 2147483647
#	sysctl net.ipv4.tcp_wmem='4096 65536 33554432' # TCP autotuning write-buffer MIN DEFAULT MAX=32MB; Max allowed in Linuc is 2Gb - 2147483647
#	sysctl net.ipv4.tcp_max_syn_backlog=8096
#	@echo "Expanding Network/NIC buffer sizes; Be cautious of buffer bloat"
#	sysctl net.core.rmem_max=67108864 # 64MB per socket if needed; Max allowed in Linux is 2Gb 2147483647; 16MB is 16777216
#	sysctl net.core.wmem_max=67108864  # 64MB per socket if needed; Max allowed in Linux is 2Gb 2147483647; 16Mb is 16777216
#	sysctl net.core.netdev_max_backlog=5000 # This can be higher if needed
#	sysctl net.core.somaxconn=1000 # This can be higher if needed
#	@echo "You may want to setup something to adjust /proc/[pid]/oom_score_adj, setting it to -500 or 500" # CAUTION HERE: http://man7.org/linux/man-pages/man5/proc.5.html
#	@echo "You should also look at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-os.html"

.PHONY : tooling_Linux
tooling_Linux:
	mkdir -p ./tooling \
	&& cd tooling \
	&& wget $(adopt_openjdk_baseurl)/$(adopt_openjdk_version_dir)/$(adopt_openjdk_version_slug) \
	&& $(jdk_check_sha) \
	&& tar -xvzf $(adopt_openjdk_version_slug) \
	&& rm $(adopt_openjdk_version_slug) \
	&& wget $(alloy_url)/$(alloy_version) -O alloy_v6.0.2.jar \
	&& wget $(tla_url)/$(tla_version) -O tla2tools_v1.8.0.jar \
	&& mkdir openjml \
	&& cd openjml \
	&& wget $(openjml_url)/$(openjml_version) \
	&& unzip $(openjml_version) \
	&& rm $(openjml_version)

.PHONY : tooling_Darwin
tooling_Darwin:
	mkdir -p ./tooling \
	&& cd tooling \
	&& wget $(adopt_openjdk_baseurl)/$(adopt_openjdk_version_dir)/$(adopt_openjdk_version_slug) \
	&& $(jdk_check_sha) \
	&& tar -xvzf $(adopt_openjdk_version_slug) \
	&& rm $(adopt_openjdk_version_slug) \
	&& ln -s `pwd`/jdk-21.0.7+6/Contents/Home/bin `pwd`/jdk-21.0.7+6/bin \
	&& wget $(alloy_url)/$(alloy_version) -O alloy_v6.0.2.jar \
	&& wget $(tla_url)/$(tla_version) -O tla2tools_v1.8.0.jar \
	&& mkdir openjml \
	&& cd openjml \
	&& wget $(openjml_url)/$(openjml_version) \
	&& unzip $(openjml_version) \
	&& rm $(openjml_version)