-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
598 lines (463 loc) · 19.6 KB
/
Makefile
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
##
## EPITECH PROJECT, 2019
## Any Project.
## File description:
## Generic Makefile (MADE BY : [email protected])
##
##################################################
# #
# #
# GENERAL ARCHITECTURE #
# #
# #
##################################################
#=============================#
# == Project Description == #
#=============================#
#############################################################################################################
PROJECT = Malloc
BIN_NAME = malloc
LIB_NAME = my_malloc
LIB_FLAG = lib
#LIB_USED = #-lm, lncurses
#############################################################################################################
#=============================#
# == Project Files == #
#=============================#
#############################################################################################################
MAIN_FILE = my_malloc.c
SRC_FILES = api/malloc.c \
api/calloc.c \
api/realloc.c \
api/reallocarray.c \
api/free.c \
internal/arena_control.c \
internal/block_alloc.c \
internal/metadata_control.c \
internal/size_control.c \
internal/find_ptr.c \
TSRC_FILES = internal/size_control.c \
LIB_FILES = # \
TESTS_FILES = wrap_malloc.c \
#############################################################################################################
#===================================#
# == Project Folder Architecture == #
#===================================#
#############################################################################################################
####################
# Setup PROJECT path.
#PROJECT_FOLDER = .
#PROJECT_DIR = $(addsuffix /, $(PROJECT_FOLDER))
####################
# Setup SRC directory architecture.
SRC_FOLDER = src
SRC_DIR = $(addprefix $(PROJECT_DIR), $(addsuffix /, $(SRC_FOLDER)))
####################
# Setup INCLUDE directory architecture.
INCLUDE_FOLDER = include
INCLUDE_DIR = $(addprefix $(PROJECT_DIR), $(addsuffix /, $(INCLUDE_FOLDER)))
####################
# Setup LIB directory architecture.
LIB_FOLDER = .
LIB_DIR = $(addprefix $(PROJECT_DIR), $(addsuffix /, $(LIB_FOLDER)))
####################
# Setup TESTS directories architecture.
TESTS_FOLDER = tests
TESTS_SRC_FOLDER = src
TESTS_INCLUDE_FOLDER = include
TESTS_RESSOURCES_FOLDER = ressources
TESTS_DIR = $(addprefix $(PROJECT_DIR), $(addsuffix /, $(TESTS_FOLDER)))
TESTS_SRC_DIR = $(addprefix $(TESTS_DIR), $(addsuffix /, $(TESTS_SRC_FOLDER)))
TESTS_INCLUDE_DIR = $(addprefix $(TESTS_DIR), $(addsuffix /, $(TESTS_INCLUDE_FOLDER)))
#############################################################################################################
#===================================#
# == Project Files Architecture == #
#===================================#
#############################################################################################################
####################
# Setup rule to transform LIB_SRC_FILES into OBJ.
MAIN := $(MAIN_FILE:.c=.o)
####################
# Setup SRC_FILES path.
SRC := $(addprefix $(SRC_DIR), $(SRC_FILES))
####################
# Setup SRC_FILES path to use in unit tests.
TSRC := $(addprefix $(SRC_DIR), $(TSRC_FILES))
####################
# Setup rule to transform SRC into OBJ.
OBJ := $(SRC:.c=.o)
####################
# Setup LIB_SRC_FILES path.
LIB_SRC := $(addprefix $(LIB_DIR), $(LIB_FILES))
####################
# Setup rule to transform LIB_SRC_FILES into OBJ.
LIB_OBJ := $(LIB_SRC:.c=.o)
####################
# Setup LIB name with the lib tag (ex: libmy.a).
LSNAME := $(addprefix $(LIB_FLAG), $(addsuffix .so, $(LIB_NAME)))
LDNAME := $(addprefix $(LIB_FLAG), $(addsuffix .a, $(LIB_NAME)))
####################
# Setup LIB path.
LD_LIB := $(addprefix $(LIB_DIR), $(LSNAME))
####################
# Setup TESTS_SRC_FILES path.
TESTS_SRC := $(addprefix $(TESTS_SRC_DIR), $(TESTS_FILES))
####################
# Setup rule to transform LIB_SRC_FILES into OBJ.
TESTS_OBJ := $(TESTS_SRC:.c=.o)
#############################################################################################################
##################################################
# #
# #
# ESSENTIALS #
# #
# #
##################################################
#=============================#
# == FUNDAMENTALS == #
#=============================#
#############################################################################################################
####################
# Setup UNIT_TESTS RULE name and UNIT_TESTS binary name.
UTESTS_RUN = tests_run
TESTS_BIN = unit_tests
####################
# Setup WRAP_MALLOC RULE.
WRAP_MALLOC = FALSE
####################
# Setup FUNCTIONNALS_TESTS RULE name and FUNCTIONNALS_TESTS script name.
#FTESTS_RUN = ftests_run
#FTESTS_BIN = ftests
####################
# Setup GDB and VALGRIND RULE.
GDB = gdb_run
VALGRIND = val_run
####################
# Setup UTILS commands.
SHELL ?= /bin/sh
MAKE = make --silent -C
RM = rm -f
CP = cp -t
MV = mv -t
GCOV = gcovr
CC = gcc
#CC = clang
LD = ar rc
#############################################################################################################
#===================================#
# == Custom Compilation Settings == #
#===================================#
#############################################################################################################
####################
# Setup define in compilation settings (ex: -DREAD_SIZE=5 || -D_WRAP_MALLOC_).
DEFINE += #if define necessary
####################
# Setup includes flags.
INCLUDES = -iquote $(INCLUDE_DIR)
TESTS_INCLUDES = -iquote $(TESTS_INCLUDE_DIR)
####################
# Setup CFLAGS and CPPFLAGS, variables used in compilation commands.
CFLAGS += $(DEFINE)
CPPFLAGS += $(INCLUDES)
####################
# Setup GCCFLAGS and CLANGFLAGS, and assert the compiler used.
GCCFLAGS += -W -Wall -Wextra -Wshadow -O1
#GCCFLAGS += -Werror
CLANGFLAGS += -Weverything
ifeq ($(CC), clang)
$(info <===== $(PROJECT) Makefile config: Using CLANG compiler =====>)
CFLAGS += $(CLANGFLAGS)
else
$(info <===== $(PROJECT) Makefile config: Using DEFAULT compiler [$(CC)] =====>)
CFLAGS += $(GCCFLAGS)
endif
####################
# Setup LIB flags to compile with correct lib.
LSHARED = -shared -fPIC -O2 -fvisibility=hidden
LDFLAGS += -L$(LIB_FOLDER) -l$(LIB_NAME)
LDLIBS += $(LIB_USED)
####################
# Setup VALGRIND flags to launch with valgrind.
VAL_FLAG += -g3
####################
# Setup VALGRIND flags to launch with GDB
GDB_FLAG += -g
#############################################################################################################
#=============================#
# == Tests Configuration == #
#=============================#
#############################################################################################################
####################
# Setup TESTS flags for TESTS Rules.
#TESTS_DEFINE += -DTESTS_RUN
TESTS_LDLIBS += -lcriterion
TESTS_FLAGS += --coverage
WRAP_MALLOC_FLAGS = -Wl,--wrap=malloc
ifeq ($(WRAP_MALLOC), TRUE)
TESTS_FLAGS += $(WRAP_MALLOC_FLAGS)
endif
TFLAGS += $(TESTS_DEFINE) $(TESTS_LDLIBS) $(TESTS_FLAGS)
####################
# Setup WRAP_MALLOC.
WRAPPERS =
ifeq ($(WRAP_MALLOC), TRUE)
$(info <===== $(PROJECT) Makefile config: Using WRAP_MALLOC =====>)
$(info <===== $(PROJECT) WRAP_FLAGS = $(WRAP_MALLOC_FLAGS) =====> )
endif
####################
# Setup FLAGS for execute Criterion binary.
TRUNFLAGS += -S
TRUNFLAGS += --timeout 5
TRUNFLAGS += --always-succeed
####################
# Setup GCOVR FLAGS to exclude some dirextories.
GCOV_EXCLUDE = tests|lib
GCOVFLAGS += -s --exclude='$(GCOV_EXCLUDE)'
#############################################################################################################
#=============================#
# == Display Variables == #
#=============================#
#############################################################################################################
####################
# Setup gcovr frame display.
BRANCH_COV = "[--- BRANCHES COVERAGE ---]"
BC_FRAME = "[-------------------------]"
LINE_COV = "[--- LINES COVERAGE ---]"
LC_FRAME = "[----------------------]"
BIN_DISP = "<----- $(PROJECT) ----->"
####################
# Setup formating/color display.
END = "\e[0m"
BOLD = "\e[1m"
UL = "\e[4m"
BLINK = "\e[5m"
MAG = "\e[35m"
WARNING = "\e[1;31m"
FRAME = "<====================================================================>"
FRAME_W = $(WARNING)$(FRAME)$(END)
FRAME_D = "\e[94m"$(FRAME)$(END)
TASK_OK = "\e[1;4;92m"
RED_BG = "\e[1;4;41m"
GREEN_BG = "\e[1;4;42m"
TITLE = "\e[1;4;31m"
#############################################################################################################
##################################################
# #
# #
# MAKEFILE RULES #
# #
# #
##################################################
#############################
# #
# Essentials #
# #
#############################
#=============================#
# == General Rules == #
#=============================#
#############################################################################################################
####################
# Rule if no rule found in make command.
.DEFAULT := all
####################
# Rule for "make"
.PHONY: all
# all: BUILD_LIB $(PROJECT)
all: BUILD_LIB
####################
# Rule for "make re".
.PHONY: re
re: fclean all
####################
# Rule for changing VARIABLES in rule execution. (ex: CFLAGS += -g3)
%.o: CFLAGS += -MT $@ -MMD
####################
# Rule for transforming .c into .o
%.o: %.c
@$(CC) $(CPPFLAGS) $(LSHARED) -c -o $@ $<
@echo -e $(MAG)"[$(PROJECT) | $(CC)] OK → $@"$(END) | cat
#############################################################################################################
#=============================#
# == Binary Rules == #
#=============================#
#############################################################################################################
.PHONY: $(PROJECT)
$(PROJECT): $(MAIN)
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(TITLE)"[$(PROJECT)]: Building with following options (ordered):"$(END) | cat
@echo -e "[$(PROJECT)]: CC = $(CC)" | cat
@echo -e "[$(PROJECT)]: SOURCES = $(SRC)" | cat
@echo -e "[$(PROJECT)]: OBJECTS = $^" | cat
@echo -e "[$(PROJECT)]: CFLAGS = $(CFLAGS)" | cat
@echo -e "[$(PROJECT)]: CPPFLAGS = $(CPPFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDFLAGS = $(LDFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDLIBS = $(LDLIBS)" | cat
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:./
$(CC) -o $(BIN_NAME) $^ $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
# @$(CC) -o $(BIN_NAME) $^ $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
@echo -e $(TASK_OK)"[$(PROJECT) | Compilation] OK\n"$(END) | cat
#############################################################################################################
#=============================#
# == Library Rules == #
#=============================#
#############################################################################################################
.PHONY: BUILD_LIB
BUILD_LIB: $(OBJ)
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(TITLE)"[$(PROJECT)]: Library $(LIB_NAME) creation:"$(END) | cat
@$(CC) -o $(LSNAME) $^ $(CFLAGS) $(CPPFLAGS) $(LSHARED)
@echo -e $(TASK_OK)"[$(PROJECT)]: Libraries created in $(LIB_FOLDER) folder !\n\n"$(END) | cat
#############################################################################################################
# #############################
# # #
# # TESTS_RUN #
# # #
# #############################
#=============================#
# == Criterion Rule == #
#=============================#
#############################################################################################################
.PHONY: $(UTESTS_RUN)
$(UTESTS_RUN): CPPFLAGS += $(TESTS_INCLUDES)
$(UTESTS_RUN): fclean $(OBJ) $(TESTS_OBJ)
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(GREEN_BG)"[$(PROJECT)]: Testing project"$(END) | cat
@echo -e $(FRAME_D) | cat
@echo -e $(TITLE)"[$(PROJECT)]: Building with following options (ordered):"$(END) | cat
@echo -e "[$(PROJECT)]: CC = $(CC)" | cat
@echo -e "[$(PROJECT)]: SRC = $(SRC)" | cat
@echo -e "[$(PROJECT)]: TESTS_SRC = $(TESTS_SRC)" | cat
@echo -e "[$(PROJECT)]: CFLAGS = $(CFLAGS)" | cat
@echo -e "[$(PROJECT)]: CPPFLAGS = $(CPPFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDFLAGS = $(LDFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDLIBS = $(LDLIBS)" | cat
@echo -e "[$(PROJECT)]: TFLAGS = $(TFLAGS)" | cat
$(CC) -o $(TESTS_BIN) $(TSRC) $(TESTS_SRC) $(CFLAGS) $(TFLAGS) $(CPPFLAGS)
@echo -e $(UL)"\n\n[$(PROJECT)]: Starting UNIT_TESTS binary."$(END) | cat
@echo -e "[$(PROJECT)]: TRUNFLAGS = $(TRUNFLAGS)\n" | cat
@-./$(TESTS_BIN) $(TRUNFLAGS)
@echo -e "\n\n[$(PROJECT)]: Moving test sources coverage files into $(TESTS_FOLDER)" | cat
@-$(MV) $(TESTS_DIR) test_*.gc*
@echo -e "[$(PROJECT)]: Gcovr Flags = $(GCOVFLAGS)" | cat
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(RED_BG)"\t\t[$(PROJECT)]: Complete coverage report"$(END) | cat
@echo -e "\e[1m\e[36m\n\t\t\t $(LC_FRAME)" | cat
@echo -e "\t\t\t $(LINE_COV)" | cat
@-echo -e "\t\t\t $(LC_FRAME)\e[0m" | cat
@$(GCOV) -r . $(GCOVFLAGS)
@echo -e "\e[1m\e[36m\n\n\t\t\t $(BC_FRAME)" | cat
@echo -e "\t\t\t $(BRANCH_COV)" | cat
@echo -e "\t\t\t $(BC_FRAME)\e[0m" | cat
@$(GCOV) -b . $(GCOVFLAGS)
@echo -e $(RED_BG)"\t\t ------------ $(PROJECT) ------------ "$(END) | cat
#############################################################################################################
#=====================================#
# == FUNCTIONNALS TESTS Rule == #
#=====================================#
#############################################################################################################
#############################################################################################################
# #############################
# # #
# # DEBUG_RUN #
# # #
# #############################
#=============================#
# == Valgrind Rules == #
#=============================#
#############################################################################################################
.PHONY: $(VALGRIND)
$(VALGRIND): CFLAGS += $(VAL_FLAG)
$(VALGRIND): fclean BUILD_LIB $(MAIN) $(OBJ)
@echo -e "\n\n"$(FRAME_W)
@echo -e "\t\t\t"$(RED_BG)"USING VALGRIND MODE !!!!"$(END)
@echo -e $(FRAME_W)"\n\n"
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(TITLE)"[$(PROJECT)]: Building with following options (ordered):"$(END) | cat
@echo -e "[$(PROJECT)]: CC = $(CC)" | cat
@echo -e "[$(PROJECT)]: SOURCES = $(SRC)" | cat
@echo -e "[$(PROJECT)]: OBJECTS = $(MAIN) $(OBJ)" | cat
@echo -e "[$(PROJECT)]: CFLAGS = $(CFLAGS)" | cat
@echo -e "[$(PROJECT)]: CPPFLAGS = $(CPPFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDFLAGS = $(LDFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDLIBS = $(LDLIBS)" | cat
@$(CC) -o $(BIN_NAME) $(MAIN) $(OBJ) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
@echo -e $(TASK_OK)"[$(PROJECT) | Compilation] OK\n"$(END) | cat
#############################################################################################################
#=============================#
# == GDB Rules == #
#=============================#
#############################################################################################################
.PHONY: $(GDB)
$(GDB): CFLAGS += $(GDB_FLAG)
$(GDB): $(MAIN) $(OBJ)
@echo -e "\n\n"$(FRAME_W)
@echo -e "\t\t\t"$(RED_BG)"GDB MODE !!!!"$(END)
@echo -e $(FRAME_W)"\n\n"
@echo -e "\n\n"$(FRAME_D) | cat
@echo -e $(TITLE)"[$(PROJECT)]: Building with following options (ordered):"$(END) | cat
@echo -e "[$(PROJECT)]: CC = $(CC)" | cat
@echo -e "[$(PROJECT)]: SOURCES = $(SRC)" | cat
@echo -e "[$(PROJECT)]: OBJECTS = $^" | cat
@echo -e "[$(PROJECT)]: CFLAGS = $(CFLAGS)" | cat
@echo -e "[$(PROJECT)]: CPPFLAGS = $(CPPFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDFLAGS = $(LDFLAGS)" | cat
@echo -e "[$(PROJECT)]: LDLIBS = $(LDLIBS)" | cat
@$(CC) -o $(BIN_NAME) $^ $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
@echo -e "[$(PROJECT) | Compilation] OK\n" $(END) | cat
#############################################################################################################
# #############################
# # #
# # CLEAN-UP #
# # #
# #############################
#===================================#
# == Object Files Cleanup Rule == #
#===================================#
################################################################################
.PHONY: $(obj_clean)
obj_clean:
@echo -e "[$(PROJECT)]: Removing object files." | cat
@-$(RM) $(OBJ) $(MAIN:.c=.o)
@echo -e "[$(PROJECT)]: Removing lib object files." | cat
@-$(RM) $(LIB_OBJ)
@echo -e "[$(PROJECT)]: Removing tests object files (if any)." | cat
@-$(RM) $(TESTS_SRC_DIR)/*.o
@-$(RM) *.o
#===================================#
# == Library Files Cleanup Rule == #
#===================================#
################################################################################
.PHONY: $(lib_clean)
lib_clean:
@echo -e "[$(PROJECT)]: Removing library $(LIB_NAME) file." | cat
@-$(RM) $(LD_LIB)
#===================================#
# == Tests Files Cleanup Rule == #
#===================================#
################################################################################
.PHONY: $(tests_clean)
tests_clean:
@echo -e "[$(PROJECT)]: Removing coverage files." | cat
@-$(RM) *.gc* $(TESTS_DIR)/*.gc*
@-$(RM) *.gc* $(LIB_DIR)/*.gc*
@-$(RM) *.gc* $(TESTS_DIR)/*.o
@echo -e "[$(PROJECT)]: Removing test binary." | cat
@-$(RM) $(TESTS_BIN)
#===================================#
# == Aclean Cleanup Rule == #
#===================================#
################################################################################
.PHONY: $(aclean)
aclean: obj_clean lib_clean tests_clean
#===================================#
# == Fclean Cleanup Rule == #
#===================================#
################################################################################
.PHONY: $(fclean)
fclean: aclean
@echo -e "[$(PROJECT)]: Removing binary." | cat
@-$(RM) $(BIN_NAME)
@echo -e $(TASK_OK)"\n[$(PROJECT)]: Project cleaned !"$(END) | cat
@echo -e $(FRAME_D)"\n\n"
#############################################################################################################