Makefile 10.5 KB
Newer Older
Richard van der Hoff's avatar
Richard van der Hoff committed
1
2
#!/usr/bin/make -f

3
include common.mk
4
VERSION := $(MAJOR).$(MINOR).$(PATCH)
5
PREFIX ?= /usr/local
6
BUILD_DIR := build
7
8
RELEASE_OPTIMIZE_FLAGS ?= -g -O3
DEBUG_OPTIMIZE_FLAGS ?= -g -O0
9
JS_OPTIMIZE_FLAGS ?= -O3
10
FUZZING_OPTIMIZE_FLAGS ?= -O3
Richard van der Hoff's avatar
Richard van der Hoff committed
11
CC = gcc
12
EMCC = emcc
13
AFL_CC = afl-gcc
14
AFL_CXX = afl-g++
15
AR = ar
16

17
RELEASE_TARGET := $(BUILD_DIR)/libolm.so.$(VERSION)
18
STATIC_RELEASE_TARGET := $(BUILD_DIR)/libolm.a
19
DEBUG_TARGET := $(BUILD_DIR)/libolm_debug.so.$(VERSION)
David Baker's avatar
David Baker committed
20
21
JS_WASM_TARGET := javascript/olm.js
JS_ASMJS_TARGET := javascript/olm_legacy.js
22
23

JS_EXPORTED_FUNCTIONS := javascript/exported_functions.json
David Baker's avatar
David Baker committed
24
JS_EXTRA_EXPORTED_RUNTIME_METHODS := ALLOC_STACK
David Baker's avatar
David Baker committed
25
JS_EXTERNS := javascript/externs.js
26

27
PUBLIC_HEADERS := include/olm/olm.h include/olm/outbound_group_session.h include/olm/inbound_group_session.h include/olm/pk.h
Richard van der Hoff's avatar
Richard van der Hoff committed
28

29
30
31
32
33
SOURCES := $(wildcard src/*.cpp) $(wildcard src/*.c) \
    lib/crypto-algorithms/sha256.c \
    lib/crypto-algorithms/aes.c \
    lib/curve25519-donna/curve25519-donna.c

34
FUZZER_SOURCES := $(wildcard fuzzers/fuzz_*.cpp) $(wildcard fuzzers/fuzz_*.c)
Richard van der Hoff's avatar
Richard van der Hoff committed
35
TEST_SOURCES := $(wildcard tests/test_*.cpp) $(wildcard tests/test_*.c)
36
37
38
39
40
41
42
43
44

OBJECTS := $(patsubst %.c,%.o,$(patsubst %.cpp,%.o,$(SOURCES)))
RELEASE_OBJECTS := $(addprefix $(BUILD_DIR)/release/,$(OBJECTS))
DEBUG_OBJECTS := $(addprefix $(BUILD_DIR)/debug/,$(OBJECTS))
FUZZER_OBJECTS := $(addprefix $(BUILD_DIR)/fuzzers/objects/,$(OBJECTS))
FUZZER_BINARIES := $(addprefix $(BUILD_DIR)/,$(basename $(FUZZER_SOURCES)))
FUZZER_DEBUG_BINARIES := $(patsubst $(BUILD_DIR)/fuzzers/fuzz_%,$(BUILD_DIR)/fuzzers/debug_%,$(FUZZER_BINARIES))
TEST_BINARIES := $(patsubst tests/%,$(BUILD_DIR)/tests/%,$(basename $(TEST_SOURCES)))
JS_OBJECTS := $(addprefix $(BUILD_DIR)/javascript/,$(OBJECTS))
David Baker's avatar
David Baker committed
45
46
47
48

# pre & post are the js-pre/js-post options to emcc.
# They are injected inside the modularised code and
# processed by the optimiser.
49
JS_PRE := $(wildcard javascript/*pre.js)
50
51
JS_POST := javascript/olm_outbound_group_session.js \
    javascript/olm_inbound_group_session.js \
52
    javascript/olm_pk.js \
53
    javascript/olm_post.js
David Baker's avatar
David Baker committed
54
55
56
57
58
59
60

# The prefix & suffix are just added onto the start & end
# of what comes out emcc, so are outside of the modularised
# code and not seen by the opimiser.
JS_PREFIX := javascript/olm_prefix.js
JS_SUFFIX := javascript/olm_suffix.js

61
DOCS := tracing/README.html \
62
    docs/megolm.html \
63
    docs/olm.html \
64
    docs/signing.html \
65
66
    README.html \
    CHANGELOG.html
Richard van der Hoff's avatar
Richard van der Hoff committed
67

68
69
70
71
CPPFLAGS += -Iinclude -Ilib \
    -DOLMLIB_VERSION_MAJOR=$(MAJOR) -DOLMLIB_VERSION_MINOR=$(MINOR) \
    -DOLMLIB_VERSION_PATCH=$(PATCH)

72
73
# we rely on <stdint.h>, which was introduced in C99
CFLAGS += -Wall -Werror -std=c99 -fPIC
74
75
CXXFLAGS += -Wall -Werror -std=c++11 -fPIC
LDFLAGS += -Wall -Werror
Richard van der Hoff's avatar
Richard van der Hoff committed
76

David Baker's avatar
David Baker committed
77
EMCCFLAGS = --closure 1 --memory-init-file 0 -s NO_FILESYSTEM=1 -s INVOKE_RUN=0 -s MODULARIZE=1
78
79
80
81
# NO_BROWSER is kept for compatibility with emscripten 1.35.24, but is no
# longer needed.
EMCCFLAGS += -s NO_BROWSER=1

David Baker's avatar
David Baker committed
82
83
84
85
86
87
# Olm generally doesn't need a lot of memory to encrypt / decrypt its usual
# payloads (ie. Matrix messages), but we do need about 128K of heap to encrypt
# a 64K event (enough to store the ciphertext and the plaintext, bearing in
# mind that the plaintext can only be 48K because base64). We also have about
# 36K of statics. So let's have 256K of memory.
# (This can't be changed by the app with wasm since it's baked into the wasm).
David Baker's avatar
David Baker committed
88
89
90
# (emscripten also mandates at least 16MB of memory for asm.js now, so
# we don't use this for the legacy build.)
EMCCFLAGS_WASM += -s TOTAL_STACK=65536 -s TOTAL_MEMORY=262144
David Baker's avatar
David Baker committed
91

David Baker's avatar
David Baker committed
92
EMCCFLAGS_ASMJS += -s WASM=0
David Baker's avatar
David Baker committed
93

94
95
96
97
EMCC.c = $(EMCC) $(CFLAGS) $(CPPFLAGS) -c
EMCC.cc = $(EMCC) $(CXXFLAGS) $(CPPFLAGS) -c
EMCC_LINK = $(EMCC) $(LDFLAGS) $(EMCCFLAGS)

98
99
100
101
102
AFL.c = $(AFL_CC) $(CFLAGS) $(CPPFLAGS) -c
AFL.cc = $(AFL_CXX) $(CXXFLAGS) $(CPPFLAGS) -c
AFL_LINK.c = $(AFL_CC) $(LDFLAGS) $(CFLAGS) $(CPPFLAGS)
AFL_LINK.cc = $(AFL_CXX) $(LDFLAGS) $(CXXFLAGS) $(CPPFLAGS)

Richard van der Hoff's avatar
Richard van der Hoff committed
103
104
105
106
107
# generate .d files when compiling
CPPFLAGS += -MMD

### per-target variables

108
109
110
111
112
113
114
$(RELEASE_OBJECTS): CFLAGS += $(RELEASE_OPTIMIZE_FLAGS)
$(RELEASE_OBJECTS): CXXFLAGS += $(RELEASE_OPTIMIZE_FLAGS)
$(RELEASE_TARGET): LDFLAGS += $(RELEASE_OPTIMIZE_FLAGS)

$(DEBUG_OBJECTS): CFLAGS += $(DEBUG_OPTIMIZE_FLAGS)
$(DEBUG_OBJECTS): CXXFLAGS += $(DEBUG_OPTIMIZE_FLAGS)
$(DEBUG_TARGET): LDFLAGS += $(DEBUG_OPTIMIZE_FLAGS)
Richard van der Hoff's avatar
Richard van der Hoff committed
115
116

$(TEST_BINARIES): CPPFLAGS += -Itests/include
Richard van der Hoff's avatar
Richard van der Hoff committed
117
$(TEST_BINARIES): LDFLAGS += $(DEBUG_OPTIMIZE_FLAGS) -L$(BUILD_DIR)
Richard van der Hoff's avatar
Richard van der Hoff committed
118

119
120
121
122
123
124
125
$(FUZZER_OBJECTS): CFLAGS += $(FUZZER_OPTIMIZE_FLAGS)
$(FUZZER_OBJECTS): CXXFLAGS += $(FUZZER_OPTIMIZE_FLAGS)
$(FUZZER_BINARIES): CPPFLAGS += -Ifuzzers/include
$(FUZZER_BINARIES): LDFLAGS += $(FUZZER_OPTIMIZE_FLAGS) -L$(BUILD_DIR)
$(FUZZER_DEBUG_BINARIES): CPPFLAGS += -Ifuzzers/include
$(FUZZER_DEBUG_BINARIES): LDFLAGS += $(DEBUG_OPTIMIZE_FLAGS)

126
127
$(JS_OBJECTS): CFLAGS += $(JS_OPTIMIZE_FLAGS)
$(JS_OBJECTS): CXXFLAGS += $(JS_OPTIMIZE_FLAGS)
David Baker's avatar
David Baker committed
128
129
$(JS_WASM_TARGET): LDFLAGS += $(JS_OPTIMIZE_FLAGS)
$(JS_ASMJS_TARGET): LDFLAGS += $(JS_OPTIMIZE_FLAGS)
130

131
132
133
134
135
136
137
138
139
140
141
142
143
### Fix to make mkdir work on windows and linux
ifeq ($(shell echo "check_quotes"),"check_quotes")
   WINDOWS := yes
else
   WINDOWS := no
endif

ifeq ($(WINDOWS),yes)
   mkdir = mkdir $(subst /,\,$(1)) > nul 2>&1 || (exit 0)
else
   mkdir = mkdir -p $(1)
endif

Richard van der Hoff's avatar
Richard van der Hoff committed
144
145
### top-level targets

146
lib: $(RELEASE_TARGET)
147
148
.PHONY: lib

149
150
$(RELEASE_TARGET): $(RELEASE_OBJECTS)
	$(CXX) $(LDFLAGS) --shared -fPIC \
151
            -Wl,-soname,libolm.so.$(MAJOR) \
152
153
            -Wl,--version-script,version_script.ver \
            $(OUTPUT_OPTION) $(RELEASE_OBJECTS)
154
	ln -sf libolm.so.$(VERSION) $(BUILD_DIR)/libolm.so.$(MAJOR)
155

156
debug: $(DEBUG_TARGET)
157
158
159
.PHONY: debug

$(DEBUG_TARGET): $(DEBUG_OBJECTS)
160
	$(CXX) $(LDFLAGS) --shared -fPIC \
161
            -Wl,-soname,libolm_debug.so.$(MAJOR) \
162
163
            -Wl,--version-script,version_script.ver \
            $(OUTPUT_OPTION) $(DEBUG_OBJECTS)
164
	ln -sf libolm_debug.so.$(VERSION) $(BUILD_DIR)/libolm_debug.so.$(MAJOR)
165

166
167
168
169
static: $(STATIC_RELEASE_TARGET)
.PHONY: static

$(STATIC_RELEASE_TARGET): $(RELEASE_OBJECTS)
170
	$(AR) rcs $@ $^
171

David Baker's avatar
David Baker committed
172
js: $(JS_WASM_TARGET) $(JS_ASMJS_TARGET)
173
174
.PHONY: js

David Baker's avatar
David Baker committed
175
176
177
# Note that the output file we give to emcc determines the name of the
# wasm file baked into the js, hence messing around outputting to olm.js
# and then renaming it.
David Baker's avatar
David Baker committed
178
$(JS_WASM_TARGET): $(JS_OBJECTS) $(JS_PRE) $(JS_POST) $(JS_EXPORTED_FUNCTIONS) $(JS_PREFIX) $(JS_SUFFIX)
David Baker's avatar
David Baker committed
179
	EMCC_CLOSURE_ARGS="--externs $(JS_EXTERNS)" $(EMCC_LINK) \
David Baker's avatar
David Baker committed
180
181
182
183
184
185
186
187
188
189
190
191
192
	       $(EMCCFLAGS_WASM) \
               $(foreach f,$(JS_PRE),--pre-js $(f)) \
               $(foreach f,$(JS_POST),--post-js $(f)) \
               -s "EXPORTED_FUNCTIONS=@$(JS_EXPORTED_FUNCTIONS)" \
               -s "EXTRA_EXPORTED_RUNTIME_METHODS=$(JS_EXTRA_EXPORTED_RUNTIME_METHODS)" \
               $(JS_OBJECTS) -o $@
	       mv $@ javascript/olmtmp.js
	       cat $(JS_PREFIX) javascript/olmtmp.js $(JS_SUFFIX) > $@
	       rm javascript/olmtmp.js

$(JS_ASMJS_TARGET): $(JS_OBJECTS) $(JS_PRE) $(JS_POST) $(JS_EXPORTED_FUNCTIONS) $(JS_PREFIX) $(JS_SUFFIX)
	EMCC_CLOSURE_ARGS="--externs $(JS_EXTERNS)" $(EMCC_LINK) \
	       $(EMCCFLAGS_ASMJS) \
193
194
               $(foreach f,$(JS_PRE),--pre-js $(f)) \
               $(foreach f,$(JS_POST),--post-js $(f)) \
195
               -s "EXPORTED_FUNCTIONS=@$(JS_EXPORTED_FUNCTIONS)" \
David Baker's avatar
David Baker committed
196
               -s "EXTRA_EXPORTED_RUNTIME_METHODS=$(JS_EXTRA_EXPORTED_RUNTIME_METHODS)" \
197
               $(JS_OBJECTS) -o $@
David Baker's avatar
David Baker committed
198
199
200
	       mv $@ javascript/olmtmp.js
	       cat $(JS_PREFIX) javascript/olmtmp.js $(JS_SUFFIX) > $@
	       rm javascript/olmtmp.js
201

Richard van der Hoff's avatar
Richard van der Hoff committed
202
203
204
205
206
build_tests: $(TEST_BINARIES)

test: build_tests
	for i in $(TEST_BINARIES); do \
	    echo $$i; \
207
	    $$i || exit $$?; \
Richard van der Hoff's avatar
Richard van der Hoff committed
208
209
	done

210
211
212
fuzzers: $(FUZZER_BINARIES) $(FUZZER_DEBUG_BINARIES)
.PHONY: fuzzers

213
$(JS_EXPORTED_FUNCTIONS): $(PUBLIC_HEADERS)
214
	perl -MJSON -ne '$$f{"_$$1"}=1 if /(olm_[^( ]*)\(/; END { @f=sort keys %f; print encode_json \@f }' $^ > $@.tmp
215
216
	mv $@.tmp $@

217
all: test js lib debug doc
218
219
.PHONY: all

220
install-headers: $(PUBLIC_HEADERS)
221
	test -d $(DESTDIR)$(PREFIX)/include/olm || $(call mkdir,$(DESTDIR)$(PREFIX)/include/olm)
222
	install -Dm644 $(PUBLIC_HEADERS) $(DESTDIR)$(PREFIX)/include/olm/
223
.PHONY: install-headers
224
225

install-debug: debug install-headers
226
	test -d $(DESTDIR)$(PREFIX)/lib || $(call mkdir,$(DESTDIR)$(PREFIX)/lib)
227
228
229
230
231
	install -Dm755 $(DEBUG_TARGET) $(DESTDIR)$(PREFIX)/lib/libolm_debug.so.$(VERSION)
	ln -s libolm_debug.so.$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm_debug.so.$(MAJOR)
	ln -s libolm_debug.so.$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm_debug.so
.PHONY: install-debug

232
install: lib install-headers
233
	test -d $(DESTDIR)$(PREFIX)/lib || $(call mkdir,$(DESTDIR)$(PREFIX)/lib)
234
235
236
237
238
	install -Dm755 $(RELEASE_TARGET) $(DESTDIR)$(PREFIX)/lib/libolm.so.$(VERSION)
	ln -s libolm.so.$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm.so.$(MAJOR)
	ln -s libolm.so.$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm.so
.PHONY: install

239
clean:;
240
	rm -rf $(BUILD_DIR) $(DOCS)
241
.PHONY: clean
242

243
244
245
doc: $(DOCS)
.PHONY: doc

Richard van der Hoff's avatar
Richard van der Hoff committed
246
### rules for building objects
247
$(BUILD_DIR)/release/%.o: %.c
248
	$(call mkdir,$(dir $@))
249
250
	$(COMPILE.c) $(OUTPUT_OPTION) $<

251
$(BUILD_DIR)/release/%.o: %.cpp
252
	$(call mkdir,$(dir $@))
253
254
	$(COMPILE.cc) $(OUTPUT_OPTION) $<

255
$(BUILD_DIR)/debug/%.o: %.c
256
	$(call mkdir,$(dir $@))
Richard van der Hoff's avatar
Richard van der Hoff committed
257
258
	$(COMPILE.c) $(OUTPUT_OPTION) $<

259
$(BUILD_DIR)/debug/%.o: %.cpp
260
	$(call mkdir,$(dir $@))
Richard van der Hoff's avatar
Richard van der Hoff committed
261
262
	$(COMPILE.cc) $(OUTPUT_OPTION) $<

263
$(BUILD_DIR)/javascript/%.o: %.c
264
	$(call mkdir,$(dir $@))
265
266
	$(EMCC.c) $(OUTPUT_OPTION) $<

267
$(BUILD_DIR)/javascript/%.o: %.cpp
268
	$(call mkdir,$(dir $@))
269
270
	$(EMCC.cc) $(OUTPUT_OPTION) $<

271
$(BUILD_DIR)/tests/%: tests/%.c $(DEBUG_OBJECTS)
272
	$(call mkdir,$(dir $@))
273
	$(LINK.c) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@
Richard van der Hoff's avatar
Richard van der Hoff committed
274

275
$(BUILD_DIR)/tests/%: tests/%.cpp $(DEBUG_OBJECTS)
276
	$(call mkdir,$(dir $@))
277
	$(LINK.cc) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@
Richard van der Hoff's avatar
Richard van der Hoff committed
278

279
$(BUILD_DIR)/fuzzers/objects/%.o: %.c
280
	$(call mkdir,$(dir $@))
281
282
	$(AFL.c) $(OUTPUT_OPTION) $<

283
$(BUILD_DIR)/fuzzers/objects/%.o: %.cpp
284
	$(call mkdir,$(dir $@))
285
286
287
288
289
290
291
292
293
294
295
296
297
	$(AFL.cc) $(OUTPUT_OPTION) $<

$(BUILD_DIR)/fuzzers/fuzz_%: fuzzers/fuzz_%.c $(FUZZER_OBJECTS)
	$(AFL_LINK.c) $< $(FUZZER_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@

$(BUILD_DIR)/fuzzers/fuzz_%: fuzzers/fuzz_%.cpp $(FUZZER_OBJECTS)
	$(AFL_LINK.cc) $< $(FUZZER_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@

$(BUILD_DIR)/fuzzers/debug_%: fuzzers/fuzz_%.c $(DEBUG_OBJECTS)
	$(LINK.c) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@

$(BUILD_DIR)/fuzzers/debug_%: fuzzers/fuzz_%.cpp $(DEBUG_OBJECTS)
	$(LINK.cc) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@
Richard van der Hoff's avatar
Richard van der Hoff committed
298

299
300
301
%.html: %.rst
	rst2html $< $@

Richard van der Hoff's avatar
Richard van der Hoff committed
302
303
### dependencies

304
305
-include $(RELEASE_OBJECTS:.o=.d)
-include $(DEBUG_OBJECTS:.o=.d)
306
-include $(JS_OBJECTS:.o=.d)
Richard van der Hoff's avatar
Richard van der Hoff committed
307
-include $(TEST_BINARIES:=.d)
308
309
310
-include $(FUZZER_OBJECTS:.o=.d)
-include $(FUZZER_BINARIES:=.d)
-include $(FUZZER_DEBUG_BINARIES:=.d)