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

David Baker's avatar
David Baker committed
17
18
19
20
21
22
23
24
25
26
27
UNAME := $(shell uname)
ifeq ($(UNAME),Darwin)
	SO := dylib
	OLM_LDFLAGS :=
else
	SO := so
	OLM_LDFLAGS := -Wl,-soname,libolm.so.$(MAJOR) \
                       -Wl,--version-script,version_script.ver
endif

RELEASE_TARGET := $(BUILD_DIR)/libolm.$(SO).$(VERSION)
28
STATIC_RELEASE_TARGET := $(BUILD_DIR)/libolm.a
David Baker's avatar
David Baker committed
29
DEBUG_TARGET := $(BUILD_DIR)/libolm_debug.$(SO).$(VERSION)
David Baker's avatar
David Baker committed
30
31
JS_WASM_TARGET := javascript/olm.js
JS_ASMJS_TARGET := javascript/olm_legacy.js
32
33

JS_EXPORTED_FUNCTIONS := javascript/exported_functions.json
David Baker's avatar
David Baker committed
34
JS_EXTRA_EXPORTED_RUNTIME_METHODS := ALLOC_STACK
David Baker's avatar
David Baker committed
35
JS_EXTERNS := javascript/externs.js
36

37
PUBLIC_HEADERS := include/olm/olm.h include/olm/outbound_group_session.h include/olm/inbound_group_session.h include/olm/pk.h include/olm/sas.h
Richard van der Hoff's avatar
Richard van der Hoff committed
38

39
40
41
42
43
SOURCES := $(wildcard src/*.cpp) $(wildcard src/*.c) \
    lib/crypto-algorithms/sha256.c \
    lib/crypto-algorithms/aes.c \
    lib/curve25519-donna/curve25519-donna.c

44
FUZZER_SOURCES := $(wildcard fuzzers/fuzz_*.cpp) $(wildcard fuzzers/fuzz_*.c)
Richard van der Hoff's avatar
Richard van der Hoff committed
45
TEST_SOURCES := $(wildcard tests/test_*.cpp) $(wildcard tests/test_*.c)
46
47
48
49
50
51
52
53
54

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
55
56
57
58

# pre & post are the js-pre/js-post options to emcc.
# They are injected inside the modularised code and
# processed by the optimiser.
59
JS_PRE := $(wildcard javascript/*pre.js)
60
61
JS_POST := javascript/olm_outbound_group_session.js \
    javascript/olm_inbound_group_session.js \
62
    javascript/olm_pk.js \
63
    javascript/olm_sas.js \
64
    javascript/olm_post.js
David Baker's avatar
David Baker committed
65
66
67
68
69
70
71

# 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

72
DOCS := tracing/README.html \
73
    docs/megolm.html \
74
    docs/olm.html \
75
    docs/signing.html \
76
77
    README.html \
    CHANGELOG.html
Richard van der Hoff's avatar
Richard van der Hoff committed
78

79
80
81
82
CPPFLAGS += -Iinclude -Ilib \
    -DOLMLIB_VERSION_MAJOR=$(MAJOR) -DOLMLIB_VERSION_MINOR=$(MINOR) \
    -DOLMLIB_VERSION_PATCH=$(PATCH)

83
84
# we rely on <stdint.h>, which was introduced in C99
CFLAGS += -Wall -Werror -std=c99 -fPIC
85
86
CXXFLAGS += -Wall -Werror -std=c++11 -fPIC
LDFLAGS += -Wall -Werror
Richard van der Hoff's avatar
Richard van der Hoff committed
87

David Baker's avatar
David Baker committed
88
EMCCFLAGS = --closure 1 --memory-init-file 0 -s NO_FILESYSTEM=1 -s INVOKE_RUN=0 -s MODULARIZE=1
89

David Baker's avatar
David Baker committed
90
91
92
93
94
95
# 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
96
97
98
# (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
99

David Baker's avatar
David Baker committed
100
EMCCFLAGS_ASMJS += -s WASM=0
David Baker's avatar
David Baker committed
101

102
103
104
105
EMCC.c = $(EMCC) $(CFLAGS) $(CPPFLAGS) -c
EMCC.cc = $(EMCC) $(CXXFLAGS) $(CPPFLAGS) -c
EMCC_LINK = $(EMCC) $(LDFLAGS) $(EMCCFLAGS)

106
107
108
109
110
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
111
112
113
114
115
# generate .d files when compiling
CPPFLAGS += -MMD

### per-target variables

116
117
118
119
120
121
122
$(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
123
124

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

127
128
129
130
131
132
133
$(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)

134
135
$(JS_OBJECTS): CFLAGS += $(JS_OPTIMIZE_FLAGS)
$(JS_OBJECTS): CXXFLAGS += $(JS_OPTIMIZE_FLAGS)
David Baker's avatar
David Baker committed
136
137
$(JS_WASM_TARGET): LDFLAGS += $(JS_OPTIMIZE_FLAGS)
$(JS_ASMJS_TARGET): LDFLAGS += $(JS_OPTIMIZE_FLAGS)
138

139
140
141
142
143
144
145
146
147
148
149
150
151
### 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
152
153
### top-level targets

154
lib: $(RELEASE_TARGET)
155
156
.PHONY: lib

157
158
$(RELEASE_TARGET): $(RELEASE_OBJECTS)
	$(CXX) $(LDFLAGS) --shared -fPIC \
David Baker's avatar
David Baker committed
159
            $(OLM_LDFLAGS) \
160
            $(OUTPUT_OPTION) $(RELEASE_OBJECTS)
David Baker's avatar
David Baker committed
161
	ln -sf libolm.$(SO).$(VERSION) $(BUILD_DIR)/libolm.$(SO).$(MAJOR)
162
	ln -sf libolm.$(SO).$(VERSION) $(BUILD_DIR)/libolm.$(SO)
163

164
debug: $(DEBUG_TARGET)
165
166
167
.PHONY: debug

$(DEBUG_TARGET): $(DEBUG_OBJECTS)
168
	$(CXX) $(LDFLAGS) --shared -fPIC \
David Baker's avatar
David Baker committed
169
            $(OLM_LDFLAGS) \
170
            $(OUTPUT_OPTION) $(DEBUG_OBJECTS)
David Baker's avatar
David Baker committed
171
	ln -sf libolm_debug.$(SO).$(VERSION) $(BUILD_DIR)/libolm_debug.$(SO).$(MAJOR)
172

173
174
175
176
static: $(STATIC_RELEASE_TARGET)
.PHONY: static

$(STATIC_RELEASE_TARGET): $(RELEASE_OBJECTS)
177
	$(AR) rcs $@ $^
178

David Baker's avatar
David Baker committed
179
js: $(JS_WASM_TARGET) $(JS_ASMJS_TARGET)
180
181
.PHONY: js

David Baker's avatar
David Baker committed
182
183
184
# 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
185
$(JS_WASM_TARGET): $(JS_OBJECTS) $(JS_PRE) $(JS_POST) $(JS_EXPORTED_FUNCTIONS) $(JS_PREFIX) $(JS_SUFFIX)
David Baker's avatar
David Baker committed
186
	EMCC_CLOSURE_ARGS="--externs $(JS_EXTERNS)" $(EMCC_LINK) \
David Baker's avatar
David Baker committed
187
188
189
190
191
192
193
194
195
196
197
	       $(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)
David Baker's avatar
David Baker committed
198
	EMCC_CLOSURE_ARGS="--externs $(JS_EXTERNS)" $(EMCC_LINK) \
David Baker's avatar
David Baker committed
199
	       $(EMCCFLAGS_ASMJS) \
200
201
               $(foreach f,$(JS_PRE),--pre-js $(f)) \
               $(foreach f,$(JS_POST),--post-js $(f)) \
202
               -s "EXPORTED_FUNCTIONS=@$(JS_EXPORTED_FUNCTIONS)" \
David Baker's avatar
David Baker committed
203
               -s "EXTRA_EXPORTED_RUNTIME_METHODS=$(JS_EXTRA_EXPORTED_RUNTIME_METHODS)" \
204
               $(JS_OBJECTS) -o $@
David Baker's avatar
David Baker committed
205
206
207
	       mv $@ javascript/olmtmp.js
	       cat $(JS_PREFIX) javascript/olmtmp.js $(JS_SUFFIX) > $@
	       rm javascript/olmtmp.js
208

Richard van der Hoff's avatar
Richard van der Hoff committed
209
210
211
212
213
build_tests: $(TEST_BINARIES)

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

217
218
219
fuzzers: $(FUZZER_BINARIES) $(FUZZER_DEBUG_BINARIES)
.PHONY: fuzzers

220
$(JS_EXPORTED_FUNCTIONS): $(PUBLIC_HEADERS)
221
	./exports.py $^ > $@.tmp
222
223
	mv $@.tmp $@

224
all: test js lib debug doc
225
226
.PHONY: all

227
install-headers: $(PUBLIC_HEADERS)
228
	test -d $(DESTDIR)$(PREFIX)/include/olm || $(call mkdir,$(DESTDIR)$(PREFIX)/include/olm)
229
	install -Dm644 $(PUBLIC_HEADERS) $(DESTDIR)$(PREFIX)/include/olm/
230
.PHONY: install-headers
231
232

install-debug: debug install-headers
233
	test -d $(DESTDIR)$(PREFIX)/lib || $(call mkdir,$(DESTDIR)$(PREFIX)/lib)
David Baker's avatar
David Baker committed
234
	install -Dm755 $(DEBUG_TARGET) $(DESTDIR)$(PREFIX)/lib/libolm_debug.$(SO).$(VERSION)
235
236
	ln -sf libolm_debug.$(SO).$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm_debug.$(SO).$(MAJOR)
	ln -sf libolm_debug.$(SO).$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm_debug.$(SO)
237
238
.PHONY: install-debug

239
install: lib install-headers
240
	test -d $(DESTDIR)$(PREFIX)/lib || $(call mkdir,$(DESTDIR)$(PREFIX)/lib)
David Baker's avatar
David Baker committed
241
	install -Dm755 $(RELEASE_TARGET) $(DESTDIR)$(PREFIX)/lib/libolm.$(SO).$(VERSION)
242
243
	ln -sf libolm.$(SO).$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm.$(SO).$(MAJOR)
	ln -sf libolm.$(SO).$(VERSION) $(DESTDIR)$(PREFIX)/lib/libolm.$(SO)
244
245
.PHONY: install

246
clean:;
247
	rm -rf $(BUILD_DIR) $(DOCS)
248
.PHONY: clean
249

250
251
252
doc: $(DOCS)
.PHONY: doc

Richard van der Hoff's avatar
Richard van der Hoff committed
253
### rules for building objects
254
$(BUILD_DIR)/release/%.o: %.c
255
	$(call mkdir,$(dir $@))
256
257
	$(COMPILE.c) $(OUTPUT_OPTION) $<

258
$(BUILD_DIR)/release/%.o: %.cpp
259
	$(call mkdir,$(dir $@))
260
261
	$(COMPILE.cc) $(OUTPUT_OPTION) $<

262
$(BUILD_DIR)/debug/%.o: %.c
263
	$(call mkdir,$(dir $@))
Richard van der Hoff's avatar
Richard van der Hoff committed
264
265
	$(COMPILE.c) $(OUTPUT_OPTION) $<

266
$(BUILD_DIR)/debug/%.o: %.cpp
267
	$(call mkdir,$(dir $@))
Richard van der Hoff's avatar
Richard van der Hoff committed
268
269
	$(COMPILE.cc) $(OUTPUT_OPTION) $<

270
$(BUILD_DIR)/javascript/%.o: %.c
271
	$(call mkdir,$(dir $@))
272
273
	$(EMCC.c) $(OUTPUT_OPTION) $<

274
$(BUILD_DIR)/javascript/%.o: %.cpp
275
	$(call mkdir,$(dir $@))
276
277
	$(EMCC.cc) $(OUTPUT_OPTION) $<

278
$(BUILD_DIR)/tests/%: tests/%.c $(DEBUG_OBJECTS)
279
	$(call mkdir,$(dir $@))
280
	$(LINK.c) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@
Richard van der Hoff's avatar
Richard van der Hoff committed
281

282
$(BUILD_DIR)/tests/%: tests/%.cpp $(DEBUG_OBJECTS)
283
	$(call mkdir,$(dir $@))
284
	$(LINK.cc) $< $(DEBUG_OBJECTS) $(LOADLIBES) $(LDLIBS) -o $@
Richard van der Hoff's avatar
Richard van der Hoff committed
285

286
$(BUILD_DIR)/fuzzers/objects/%.o: %.c
287
	$(call mkdir,$(dir $@))
288
289
	$(AFL.c) $(OUTPUT_OPTION) $<

290
$(BUILD_DIR)/fuzzers/objects/%.o: %.cpp
291
	$(call mkdir,$(dir $@))
292
293
294
295
296
297
298
299
300
301
302
303
304
	$(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
305

306
307
308
%.html: %.rst
	rst2html $< $@

Richard van der Hoff's avatar
Richard van der Hoff committed
309
310
### dependencies

311
312
-include $(RELEASE_OBJECTS:.o=.d)
-include $(DEBUG_OBJECTS:.o=.d)
313
-include $(JS_OBJECTS:.o=.d)
Richard van der Hoff's avatar
Richard van der Hoff committed
314
-include $(TEST_BINARIES:=.d)
315
316
317
-include $(FUZZER_OBJECTS:.o=.d)
-include $(FUZZER_BINARIES:=.d)
-include $(FUZZER_DEBUG_BINARIES:=.d)