1# Copyright (c) 2014-2017 Cryptography Research, Inc. 2# Released under the MIT License. See LICENSE.txt for license information. 3 4 5UNAME := $(shell uname) 6MACHINE := $(shell uname -m) 7 8# Subdirectories for objects etc. 9# Many of them are mapped to build/obj right now, but could be split later. 10# The non-build/obj directories are the public interface. 11BUILD_OBJ = build/obj 12BUILD_C = src/GENERATED/c 13BUILD_H = src/GENERATED/c 14BUILD_PY = build/obj 15BUILD_LIB = build/lib 16BUILD_INC = src/GENERATED/include 17BUILD_BIN = build/bin 18BUILD_IBIN = build/obj/bin 19 20DOXYGEN ?= doxygen 21 22ifeq ($(UNAME),Darwin) 23CC ?= clang 24CXX ?= clang++ 25else 26CC ?= gcc 27CXX ?= g++ 28endif 29LD = $(CC) 30LDXX = $(CXX) 31ASM ?= $(CC) 32 33PYTHON ?= python 34 35WARNFLAGS = -pedantic -Wall -Wextra -Wunreachable-code \ 36 -Wmissing-declarations -Wunused-function -Wno-overlength-strings $(EXWARN) 37 38INCFLAGS = -Isrc/include -I$(BUILD_INC) -I$(BUILD_H) 39PUB_INCFLAGS = -I$(BUILD_INC) 40LANGFLAGS = -std=c99 -fno-strict-aliasing 41LANGXXFLAGS = -fno-strict-aliasing 42GENFLAGS = -ffunction-sections -fdata-sections -fvisibility=hidden -fomit-frame-pointer -fPIC 43OFLAGS ?= -O2 44 45MACOSX_VERSION_MIN ?= 10.9 46ifeq ($(UNAME),Darwin) 47GENFLAGS += -mmacosx-version-min=$(MACOSX_VERSION_MIN) 48endif 49 50TODAY = $(shell date "+%Y-%m-%d") 51 52ARCHFLAGS ?= -march=native 53 54ifeq ($(CC),clang) 55WARNFLAGS_C += -Wgcc-compat 56endif 57 58ifeq ($(CXX),clang++) 59WARNFLAGS_CXX += -Wgcc-compat 60endif 61 62ARCHFLAGS += $(XARCHFLAGS) 63CFLAGS = $(LANGFLAGS) $(WARNFLAGS) $(WARNFLAGS_C) $(INCFLAGS) $(OFLAGS) $(ARCHFLAGS) $(GENFLAGS) $(XCFLAGS) 64PUB_CFLAGS = $(LANGFLAGS) $(WARNFLAGS) $(WARNFLAGS_C) $(PUB_INCFLAGS) $(OFLAGS) $(ARCHFLAGS) $(GENFLAGS) $(XCFLAGS) 65CXXFLAGS = $(LANGXXFLAGS) $(WARNFLAGS) $(WARNFLAGS_CXX) $(INCFLAGS) $(OFLAGS) $(ARCHFLAGS) $(GENFLAGS) $(XCXXFLAGS) 66LDFLAGS = $(XLDFLAGS) 67ASFLAGS = $(ARCHFLAGS) $(XASFLAGS) 68 69SAGE ?= sage 70SAGES= $(shell ls test/*.sage) 71BUILDPYS= $(SAGES:test/%.sage=$(BUILD_PY)/%.py) 72 73.PHONY: clean all test test_ct bench todo doc lib bat sage sagetest gen_code gen_code_static 74.PRECIOUS: $(BUILD_C)/*/%.c $(BUILD_H)/*/%.h $(BUILD_H)/%.h $(BUILD_H)/%.hxx $(BUILD_H)/*/%.hxx $(BUILD_IBIN)/% 75 76HEADER_SRCS= $(shell find src/public_include -name "*.h*") 77HEADER_PRIVATE_SRCS= $(shell find src/include -name "*.tmpl.h*") 78GEN_CODE_0= $(HEADER_SRCS:src/public_include/%=$(BUILD_INC)/%) 79GEN_CODE_0+= $(HEADER_PRIVATE_SRCS:src/include/%=$(BUILD_C)/%) 80GEN_CODE_1= $(GEN_CODE_0:%.tmpl.h=%.h) 81GEN_CODE= $(GEN_CODE_1:%.tmpl.hxx=%.hxx) 82HEADERS= Makefile $(shell find src test -name "*.h") $(BUILD_OBJ)/timestamp $(GEN_CODE) 83 84# components needed by the lib 85LIBCOMPONENTS = $(BUILD_OBJ)/utils.o $(BUILD_OBJ)/shake.o $(BUILD_OBJ)/sha512.o $(BUILD_OBJ)/spongerng.o 86# and per-field components 87 88BENCHCOMPONENTS = $(BUILD_OBJ)/bench.o $(BUILD_OBJ)/shake.o 89 90all: lib $(BUILD_IBIN)/test $(BUILD_BIN)/ristretto $(BUILD_IBIN)/bench $(BUILD_BIN)/shakesum 91 92scan: clean 93 scan-build --use-analyzer=`which clang` \ 94 -enable-checker deadcode -enable-checker llvm \ 95 -enable-checker osx -enable-checker security -enable-checker unix \ 96 make all 97 98# Internal test programs, which are not part of the final build/bin directory. 99$(BUILD_IBIN)/test: $(BUILD_OBJ)/test_decaf.o lib 100ifeq ($(UNAME),Darwin) 101 $(LDXX) $(LDFLAGS) -o $@ $< -L$(BUILD_LIB) -ldecaf 102else 103 $(LDXX) $(LDFLAGS) -Wl,-rpath,`pwd`/$(BUILD_LIB) -o $@ $< -L$(BUILD_LIB) -ldecaf 104endif 105 106$(BUILD_BIN)/ristretto: $(BUILD_OBJ)/ristretto.o lib 107ifeq ($(UNAME),Darwin) 108 $(LDXX) $(LDFLAGS) -o $@ $< -L$(BUILD_LIB) -ldecaf 109else 110 $(LDXX) $(LDFLAGS) -Wl,-rpath,`pwd`/$(BUILD_LIB) -o $@ $< -L$(BUILD_LIB) -ldecaf 111endif 112 113# Internal test programs, which are not part of the final build/bin directory. 114$(BUILD_IBIN)/test_ct: $(BUILD_OBJ)/test_ct.o lib 115ifeq ($(UNAME),Darwin) 116 $(LDXX) $(LDFLAGS) -o $@ $< -L$(BUILD_LIB) -ldecaf 117else 118 $(LDXX) $(LDFLAGS) -Wl,-rpath,`pwd`/$(BUILD_LIB) -o $@ $< -L$(BUILD_LIB) -ldecaf 119endif 120 121$(BUILD_IBIN)/bench: $(BUILD_OBJ)/bench_decaf.o lib 122ifeq ($(UNAME),Darwin) 123 $(LDXX) $(LDFLAGS) -o $@ $< -L$(BUILD_LIB) -ldecaf 124else 125 $(LDXX) $(LDFLAGS) -Wl,-rpath,`pwd`/$(BUILD_LIB) -o $@ $< -L$(BUILD_LIB) -ldecaf 126endif 127 128# Create all the build subdirectories 129$(BUILD_OBJ)/timestamp: 130 mkdir -p $(BUILD_OBJ) $(BUILD_C) $(BUILD_PY) \ 131 $(BUILD_LIB) $(BUILD_INC) $(BUILD_BIN) $(BUILD_IBIN) $(BUILD_H) $(BUILD_INC)/decaf \ 132 $(PER_OBJ_DIRS) $(BUILD_C)/decaf 133 touch $@ 134 135$(BUILD_INC)/%: src/public_include/% $(BUILD_OBJ)/timestamp 136 cp -f $< $@ 137 138$(BUILD_INC)/%.h: src/public_include/%.tmpl.h src/generator/* 139 $(PYTHON) -B src/generator/template.py --per=global --guard=$(@:$(BUILD_INC)/%=%) -o $@ $< 140 141$(BUILD_C)/%.h: src/include/%.tmpl.h src/generator/* 142 $(PYTHON) -B src/generator/template.py --per=global --guard=$(@:$(BUILD_C)/%=%) -o $@ $< 143 144$(BUILD_INC)/%.hxx: src/public_include/%.tmpl.hxx src/generator/* 145 $(PYTHON) -B src/generator/template.py --per=global --guard=$(@:$(BUILD_INC)/%=%) -o $@ $< 146 147$(BUILD_C)/%.hxx: src/include/%.tmpl.hxx src/generator/* 148 $(PYTHON) -B src/generator/template.py --per=global --guard=$(@:$(BUILD_C)/%=%) -o $@ $< 149 150################################################################ 151# Per-field code: call with field, arch 152################################################################ 153PER_FIELD_C = $(wildcard src/per_field/*.tmpl.c) 154PER_FIELD_H = $(wildcard src/per_field/*.tmpl.h*) 155define define_field 156ARCH_FOR_$(1) ?= $(2) 157COMPONENTS_OF_$(1) = $$(BUILD_OBJ)/$(1)/f_impl.o $$(BUILD_OBJ)/$(1)/f_arithmetic.o $$(BUILD_OBJ)/$(1)/f_generic.o 158HEADERS_OF_$(1) = $(HEADERS) $$(BUILD_H)/$(1)/f_field.h 159LIBCOMPONENTS += $$(COMPONENTS_OF_$(1)) 160GEN_CODE_FOR_$(1) = $$(patsubst src/per_field/%,$(BUILD_C)/$(1)/%,$(patsubst %.tmpl.c,%.c,$(PER_FIELD_C))) 161GEN_CODE_FOR_$(1) += $$(patsubst src/per_field/%,$(BUILD_H)/$(1)/%,$(patsubst %.tmpl.h,%.h,$(PER_FIELD_H))) 162GEN_CODE += $$(GEN_CODE_FOR_$(1)) 163PER_OBJ_DIRS += $$(BUILD_OBJ)/$(1) 164 165$$(BUILD_C)/$(1)/%.c: src/per_field/%.tmpl.c src/generator/* Makefile 166 $(PYTHON) -B src/generator/template.py --per=field --guard=$(1)/`basename $$@` --item=$(1) -o $$@ $$< 167 168$$(BUILD_H)/$(1)/%.h: src/per_field/%.tmpl.h src/generator/* Makefile 169 $(PYTHON) -B src/generator/template.py --per=field --guard=$(1)/`basename $$@` --item=$(1) -o $$@ $$< 170 171$$(BUILD_OBJ)/$(1)/%.o: $$(BUILD_C)/$(1)/%.c $$(HEADERS_OF_$(1)) 172 $$(CC) $$(CFLAGS) -I src/$(1) -I src/$(1)/$$(ARCH_FOR_$(1)) -I $(BUILD_H)/$(1) \ 173 -I $(BUILD_H)/$(1)/$$(ARCH_FOR_$(1)) -I src/include/$$(ARCH_FOR_$(1)) \ 174 -c -o $$@ $$< 175 176$$(BUILD_OBJ)/$(1)/%.o: src/$(1)/%.c $$(HEADERS_OF_$(1)) 177 $$(CC) $$(CFLAGS) -I src/$(1) -I src/$(1)/$$(ARCH_FOR_$(1)) -I $(BUILD_H)/$(1) \ 178 -I $(BUILD_H)/$(1)/$$(ARCH_FOR_$(1)) -I src/include/$$(ARCH_FOR_$(1)) \ 179 -c -o $$@ $$< 180 181$$(BUILD_OBJ)/$(1)/%.o: src/$(1)/$$(ARCH_FOR_$(1))/%.c $$(HEADERS_OF_$(1)) 182 $$(CC) $$(CFLAGS) -I src/$(1) -I src/$(1)/$$(ARCH_FOR_$(1)) -I $(BUILD_H)/$(1) \ 183 -I $(BUILD_H)/$(1)/$$(ARCH_FOR_$(1)) -I src/include/$$(ARCH_FOR_$(1)) \ 184 -c -o $$@ $$< 185endef 186 187################################################################ 188# Per-field, per-curve code: call with curve, field 189################################################################ 190PER_CURVE_C = $(wildcard src/per_curve/*.tmpl.c) 191define define_curve 192 193LIBCOMPONENTS += $$(BUILD_OBJ)/$(1)/decaf.o $$(BUILD_OBJ)/$(1)/elligator.o $$(BUILD_OBJ)/$(1)/scalar.o \ 194 $$(BUILD_OBJ)/$(1)/eddsa.o $$(BUILD_OBJ)/$(1)/decaf_tables.o 195PER_OBJ_DIRS += $$(BUILD_OBJ)/$(1) 196GLOBAL_HEADERS_OF_$(1) = $(BUILD_INC)/decaf/point_$(3).h $(BUILD_INC)/decaf/point_$(3).hxx \ 197 $(BUILD_INC)/decaf/ed$(3).h $(BUILD_INC)/decaf/ed$(3).hxx 198HEADERS_OF_$(1) = $$(HEADERS_OF_$(2)) $$(GLOBAL_HEADERS_OF_$(1)) 199HEADERS += $$(GLOBAL_HEADERS_OF_$(1)) 200 201GEN_CODE_FOR_$(1) = $$(patsubst src/per_curve/%,$(BUILD_C)/$(1)/%,$(patsubst %.tmpl.c,%.c,$(PER_CURVE_C))) 202GEN_CODE_FOR_$(1) += $$(GLOBAL_HEADERS_OF_$(1)) 203GEN_CODE_P2 += $(BUILD_C)/$(1)/decaf_tables.c 204GEN_CODE += $$(GEN_CODE_FOR_$(1)) 205 206$$(BUILD_C)/$(1)/%.c: src/per_curve/%.tmpl.c src/generator/* Makefile 207 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$(1)/`basename $$@` -o $$@ $$< 208 209$$(BUILD_H)/$(1)/%.h: src/per_curve/%.tmpl.h src/generator/* Makefile 210 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$(1)/`basename $$@` -o $$@ $$< 211 212$$(BUILD_INC)/decaf/point_$(3).%: src/per_curve/point.tmpl.% src/generator/* Makefile 213 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$$(@:$(BUILD_INC)/%=%) -o $$@ $$< 214 215$$(BUILD_INC)/decaf/ed$(3).%: src/per_curve/eddsa.tmpl.% src/generator/* Makefile 216 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$$(@:$(BUILD_INC)/%=%) -o $$@ $$< 217 218$$(BUILD_INC)/decaf/elligator_$(3).%: src/per_curve/elligator.tmpl.% src/generator/* Makefile 219 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$$(@:$(BUILD_INC)/%=%) -o $$@ $$< 220 221$$(BUILD_INC)/decaf/scalar_$(3).%: src/per_curve/scalar.tmpl.% src/generator/* Makefile 222 $(PYTHON) -B src/generator/template.py --per=curve --item=$(1) --guard=$$(@:$(BUILD_INC)/%=%) -o $$@ $$< 223 224$$(BUILD_IBIN)/decaf_gen_tables_$(1): $$(BUILD_OBJ)/$(1)/decaf_gen_tables.o \ 225 $$(BUILD_OBJ)/$(1)/decaf.o $$(BUILD_OBJ)/$(1)/scalar.o $$(BUILD_OBJ)/utils.o \ 226 $$(COMPONENTS_OF_$(2)) 227 $$(LD) $$(LDFLAGS) -o $$@ $$^ 228 229$$(BUILD_C)/$(1)/decaf_tables.c: $$(BUILD_IBIN)/decaf_gen_tables_$(1) 230 ./$$< > $$@ || (rm $$@; exit 1) 231 232$$(BUILD_OBJ)/$(1)/%.o: $$(BUILD_C)/$(1)/%.c $$(HEADERS_OF_$(1)) 233 $$(CC) $$(CFLAGS) -c -o $$@ $$< \ 234 -I build/obj/curve_$(1)/ -I src/$(2) -I src/$(2)/$$(ARCH_FOR_$(2)) -I src/include/$$(ARCH_FOR_$(2)) \ 235 -I $(BUILD_H)/$(1) -I $(BUILD_H)/$(2) -I $(BUILD_H)/$(2)/$$(ARCH_FOR_$(2)) 236 237$$(BUILD_OBJ)/decaf_gen_tables_$(1).o: src/decaf_gen_tables.c $$(HEADERS_OF_$(1)) 238 $$(CC) $$(CFLAGS) \ 239 -I build/obj/curve_$(1) -I src/$(2) -I src/$(2)/$$(ARCH_FOR_$(2)) -I src/include/$$(ARCH_FOR_$(2)) \ 240 -I $(BUILD_H)/$(1) -I $(BUILD_H)/$(2) -I $(BUILD_H)/$(2)/$$(ARCH_FOR_$(2)) \ 241 -c -o $$@ $$< 242endef 243 244################################################################ 245# call code above to generate curves and fields 246$(eval $(call define_field,p25519,arch_x86_64)) 247$(eval $(call define_curve,curve25519,p25519,255)) 248$(eval $(call define_field,p448,arch_x86_64)) 249$(eval $(call define_curve,ed448goldilocks,p448,448)) 250 251# The shakesum utility is in the public bin directory. 252$(BUILD_BIN)/shakesum: $(BUILD_OBJ)/shakesum.o $(BUILD_OBJ)/shake.o $(BUILD_OBJ)/sha512.o $(BUILD_OBJ)/utils.o 253 $(LD) $(LDFLAGS) -o $@ $^ 254 255# The main decaf library, and its symlinks. 256lib: $(BUILD_LIB)/libdecaf.so 257 258$(BUILD_LIB)/libdecaf.so: $(BUILD_LIB)/libdecaf.so.1 259 ln -sf `basename $^` $@ 260 261$(BUILD_LIB)/libdecaf.so.1: $(LIBCOMPONENTS) 262 rm -f $@ 263ifeq ($(UNAME),Darwin) 264 libtool -macosx_version_min $(MACOSX_VERSION_MIN) -dynamic -dead_strip -lc -x -o $@ \ 265 $(LIBCOMPONENTS) 266else ifeq ($(UNAME),SunOS) 267 $(LD) $(LDFLAGS) -shared -Wl,-soname,`basename $@` -o $@ $(LIBCOMPONENTS) 268 strip --discard-all $@ 269else 270 $(LD) $(LDFLAGS) -shared -Wl,-soname,`basename $@` -Wl,--gc-sections -o $@ $(LIBCOMPONENTS) 271 strip --discard-all $@ 272endif 273 274 275$(BUILD_OBJ)/%.o: src/%.c $(HEADERS) 276 $(CC) $(CFLAGS) -c -o $@ $< 277 278$(BUILD_OBJ)/%.o: test/%.c $(HEADERS) 279 $(CC) $(PUB_CFLAGS) -c -o $@ $< 280 281$(BUILD_OBJ)/%.o: test/%.cxx $(HEADERS) 282 $(CXX) $(CXXFLAGS) -c -o $@ $< 283 284# The sage test scripts 285sage: $(BUILDPYS) 286 287sagetest: sage lib 288 $(SAGE) $(BUILD_PY)/test_decaf.sage 289 290$(BUILDPYS): $(SAGES) $(BUILD_OBJ)/timestamp 291 cp -f $(SAGES) $(BUILD_PY)/ 292 $(SAGE) --preparse $(SAGES:test/%.sage=$(BUILD_PY)/%.sage) 293 # some sage versions compile to .sage.py 294 for f in $(SAGES:test/%.sage=$(BUILD_PY)/%); do \ 295 if [ -e $$f.sage.py ]; then \ 296 mv $$f.sage.py $$f.py; \ 297 fi; \ 298 done 299 300# The documentation files 301$(BUILD_DOC)/timestamp: 302 mkdir -p `dirname $@` 303 touch $@ 304# 305doc: Doxyfile $(BUILD_OBJ)/timestamp gen_code_static 306 $(DOXYGEN) > /dev/null 307 308gen_code_static: $(GEN_CODE) 309gen_code: gen_code_static $(GEN_CODE_P2) 310 311# Finds todo items in .h and .c files 312TODO_TYPES ?= HACK TODO @todo FIXME BUG XXX PERF FUTURE REMOVE MAGIC UNIFY 313TODO_LOCATIONS ?= src/*.c src/include src/p* src/generator test Makefile Doxyfile 314todo:: 315 @(find $(TODO_LOCATIONS) -name '*.h' -or -name '*.c' -or -name '*.cxx' -or -name '*.hxx' -or -name '*.py') | xargs egrep --color=auto -w \ 316 `echo $(TODO_TYPES) | tr ' ' '|'` 317 @echo '=============================' 318 @(for i in $(TODO_TYPES); do \ 319 (find $(TODO_LOCATIONS) -name '*.h' -or -name '*.c' -or -name '*.cxx' -or -name '*.hxx' -or -name '*.py') | xargs egrep -w $$i > /dev/null || continue; \ 320 /bin/echo -n $$i' ' | head -c 10; \ 321 (find $(TODO_LOCATIONS) -name '*.h' -or -name '*.c' -or -name '*.cxx' -or -name '*.hxx' -or -name '*.py') | xargs egrep -w $$i| wc -l; \ 322 done) 323 @echo '=============================' 324 @echo -n 'Total ' 325 @(find $(TODO_LOCATIONS) -name '*.h' -or -name '*.c' -or -name '*.cxx' -or -name '*.hxx' -or -name '*.py') | xargs egrep -w \ 326 `echo $(TODO_TYPES) | tr ' ' '|'` | wc -l 327 328bench: $(BUILD_IBIN)/bench 329 ./$< 330 331test: $(BUILD_IBIN)/test 332 ./$< 333 334test_ct: $(BUILD_IBIN)/test_ct 335 # NB: you must compile with XCFLAGS=-DNDEBUG or you will get lots of extra warnings due to assert(thing that is always true). 336 valgrind ./$< 337 338microbench: $(BUILD_IBIN)/bench 339 ./$< --micro 340 341clean: 342 rm -fr build 343 344clean_generated: clean 345 rm -fr $(BUILD_C)/* $(BUILD_H)/* $(BUILD_INC)/* 346