5789fcf516a75232cee426d29a0e5478aa911b61
[akaros.git] / Makefile
1 # Top-level Makefile for Akaros
2 # Barret Rhoden
3 #
4 #
5 # Notes:
6 #       - I downloaded the kbuild guts from git://github.com/lacombar/kconfig.git,
7 #       and added things from a recent linux makefile.  It is from aug 2011, so
8 #       some things might not match up.
9 #       - Kernel output in obj/: So Linux has the ability to output into another
10 #       directory, via the KBUILD_OUTPUT variable.  This induces a recursive make
11 #       in the output directory.  I mucked with it for a little, but didn't get it
12 #       to work quite right.  Also, there will be other Akaros issues since this
13 #       makefile is also used for userspace and tests.  For now, I'm leaving things
14 #       the default Linux way.
15 #       - Kconfig wants to use include/ in the root directory.  We can change some
16 #       of the default settings that silentoldconfig uses, but I'll leave it as-is
17 #       for now, and just symlink that into kern/include.  It'll be easier for us,
18 #       and also potentially easier if we ever move kern/ up a level.  Similarly,
19 #       there are default Kconfigs in arch/, not in kern/arch.  I just symlinked
20 #       arch->kern/arch to keep everything simple.
21 #
22 # TODO:
23 #       - Consider merging the two target-detection bits (Linux's config, mixed, or
24 #       dot target, and the symlink handling).  Also, could consider moving around
25 #       the KFS and EXT2 targets.  Clean doesn't need to know about them, for
26 #       instance.
27 #
28 #       - Review, with an eye for being better about $(srctree).  It might only be
29 #       necessary in this file, if we every do the KBUILD_OUTPUT option.  But we
30 #       don't always want it (like for the implicit rule for Makefile)
31 #
32 #       - It's a bit crazy that we build symlinks for parlib, instead of it
33 #       managing its own links based on $(ARCH)
34 #
35 #       - Consider using Kbuild to build userspace and tests
36 #
37 #       - There are a few other TODOs sprinkled throughout the makefile.
38
39 # Do not:
40 # o  use make's built-in rules and variables
41 #    (this increases performance and avoids hard-to-debug behaviour);
42 # o  print "Entering directory ...";
43 MAKEFLAGS += -rR --no-print-directory
44
45 # That's our default target when none is given on the command line
46 # This can be overriden with a Makelocal
47 PHONY := all
48 all: akaros-kernel
49
50 # Export the location of this top level directory
51 AKAROS_ROOT = $(CURDIR)
52 export AKAROS_ROOT
53
54 # Setup dumping ground for object files and any temporary files we need to
55 # generate for non-kbuild targets
56 OBJDIR ?= obj
57
58 # Symlinks
59 # =========================================================================
60 # We have a few symlinks so that code can include <arch/whatever.h>.  This
61 # section builds and maintains those, as best we can.
62 #
63 # When invoking make, we can pass in ARCH=some-arch.  This value gets 'saved'
64 # in the symlink, so that later invocations do not need ARCH=.  If this value
65 # differs from the symlink, it appears like we are changing arches, which
66 # triggers a clean and symlink reconstruction.
67 #
68 # When the user changes from one arch to another, they ought to reconfig, since
69 # many of the CONFIG_ vars will depend on the arch.  If they try anything other
70 # than one of the "non-build-goals" (cleans or configs), we'll abort.
71 #
72 # Make targets that need these symlinks (like building userspace, the kernel,
73 # configs, etc, should depend on symlinks.
74
75 clean-goals := clean mrproper realclean userclean testclean doxyclean objclean
76 non-build-goals := %config $(clean-goals)
77 ifeq ($(filter $(non-build-goals), $(MAKECMDGOALS)),)
78 goals-has-build-targets := 1
79 endif
80
81 PHONY += symlinks clean_symlinks
82 clean_symlinks: objclean
83         @rm -f kern/include/arch kern/boot user/parlib/include/arch
84
85 arch-link := $(notdir $(shell readlink kern/include/arch))
86 valid-arches := $(notdir $(wildcard kern/arch/*))
87
88 ifneq ($(ARCH),)
89     ifeq ($(filter $(valid-arches), $(ARCH)),)
90         $(error ARCH $(ARCH) invalid, must be one of: $(valid-arches))
91     endif
92     ifneq ($(ARCH),$(arch-link))
93         ifeq ($(goals-has-build-targets),1)
94             $(error Attempted to make [$(MAKECMDGOALS)] while changing ARCH. \
95                     You need to make *config.)
96         endif
97 symlinks: clean_symlinks
98         @echo Making symlinks...
99         $(Q)ln -fs ../arch/$(ARCH) kern/include/arch
100         $(Q)ln -fs arch/$(ARCH)/boot kern/boot
101         $(Q)ln -fs $(ARCH) user/parlib/include/arch
102         $(Q)$(MAKE) -f $(srctree)/Makefile clean
103
104     else
105 symlinks:
106
107     endif # ifneq ($(ARCH),$(arch-link))
108 else # $(ARCH) is empty
109     ifneq ($(arch-link),)
110         ARCH := $(arch-link)
111 symlinks:
112
113     else
114         # Only allow a clean
115         ifeq ($(filter $(clean-goals), $(MAKECMDGOALS)),)
116             $(error No arch saved or specified.  Make *config with ARCH=arch. \
117                     'arch' must be one of: $(valid-arches))
118         endif
119         ARCH := none # catch bugs
120     endif # ifneq ($(arch-link),)
121 endif # ifeq ($(ARCH),)
122
123 SRCARCH := $(ARCH)
124 export ARCH SRCARCH
125
126 # Generic Kbuild Environment
127 # =========================================================================
128
129 # To put more focus on warnings, be less verbose as default
130 # Use 'make V=1' to see the full commands
131
132 ifeq ("$(origin V)", "command line")
133   KBUILD_VERBOSE = $(V)
134 endif
135 ifndef KBUILD_VERBOSE
136   KBUILD_VERBOSE = 0
137 endif
138
139 srctree         := $(if $(KBUILD_SRC),$(KBUILD_SRC),$(CURDIR))
140 objtree         := $(CURDIR)
141
142 export srctree objtree
143
144 CONFIG_SHELL := $(shell if [ -x "$$BASH" ]; then echo $$BASH; \
145           else if [ -x /bin/bash ]; then echo /bin/bash; \
146           else echo sh; fi ; fi)
147
148 HOSTCC       = gcc
149 HOSTCXX      = g++
150 HOSTCFLAGS   = -Wall -Wno-char-subscripts -Wmissing-prototypes \
151                -Wstrict-prototypes -O2 -fomit-frame-pointer
152 HOSTCXXFLAGS = -O2
153
154 export CONFIG_SHELL HOSTCC HOSTCXX HOSTCFLAGS HOSTCXXFLAGS
155
156 # Beautify output
157 # ---------------------------------------------------------------------------
158 #
159 # Normally, we echo the whole command before executing it. By making
160 # that echo $($(quiet)$(cmd)), we now have the possibility to set
161 # $(quiet) to choose other forms of output instead, e.g.
162 #
163 #         quiet_cmd_cc_o_c = Compiling $(RELDIR)/$@
164 #         cmd_cc_o_c       = $(CC) $(c_flags) -c -o $@ $<
165 #
166 # If $(quiet) is empty, the whole command will be printed.
167 # If it is set to "quiet_", only the short version will be printed. 
168 # If it is set to "silent_", nothing will be printed at all, since
169 # the variable $(silent_cmd_cc_o_c) doesn't exist.
170 #
171 # A simple variant is to prefix commands with $(Q) - that's useful
172 # for commands that shall be hidden in non-verbose mode.
173 #
174 #       $(Q)ln $@ :<
175 #
176 # If KBUILD_VERBOSE equals 0 then the above command will be hidden.
177 # If KBUILD_VERBOSE equals 1 then the above command is displayed.
178
179 ifeq ($(KBUILD_VERBOSE),1)
180   quiet =
181   Q =
182 else
183   quiet=quiet_
184   Q = @
185 endif
186 export quiet Q KBUILD_VERBOSE
187
188 # We need some generic definitions (do not try to remake the file).
189 $(srctree)/scripts/Kbuild.include: ;
190 include $(srctree)/scripts/Kbuild.include
191
192 # Kbuild Target/Goals Parsing
193 # =========================================================================
194 # Need to figure out if we're a config or not, and whether or not to include
195 # our .config / auto.conf.  Configs are basically their own makefile, (ifeq),
196 # and cleans are allowed to proceed without worrying about the dot-config.
197
198 # Basic helpers built in scripts/
199 PHONY += scripts_basic
200 scripts_basic:
201         $(Q)$(MAKE) $(build)=scripts/basic
202
203 PHONY += scripts
204
205 scripts: scripts_basic include/config/auto.conf include/config/tristate.conf
206         $(Q)$(MAKE) $(build)=$(@)
207
208 config-targets := 0
209 mixed-targets  := 0
210 dot-config     := 1
211
212 no-dot-config-targets := $(clean-goals)
213
214 ifneq ($(filter $(no-dot-config-targets), $(MAKECMDGOALS)),)
215     ifeq ($(filter-out $(no-dot-config-targets), $(MAKECMDGOALS)),)
216         dot-config := 0
217     endif
218 endif
219
220 ifneq ($(filter config %config,$(MAKECMDGOALS)),)
221     config-targets := 1
222     ifneq ($(filter-out config %config,$(MAKECMDGOALS)),)
223         mixed-targets := 1
224     endif
225 endif
226
227 ifeq ($(mixed-targets),1)
228 # ===========================================================================
229 # We're called with mixed targets (*config and build targets).
230 # Handle them one by one.
231
232 %:: FORCE
233         $(Q)$(MAKE) -C $(srctree) KBUILD_SRC= $@
234
235 else
236 ifeq ($(config-targets),1)
237 # ===========================================================================
238 # *config targets only - make sure prerequisites are updated, and descend
239 # in scripts/kconfig to make the *config target
240
241 # Default config file, per arch.  This path will resolve to
242 # arch/$ARCH/configs/defconfig (arch -> kern/arch).  Each arch can override
243 # this if they want, or just symlink to one in the main root directory.
244 KBUILD_DEFCONFIG := defconfig
245 export KBUILD_DEFCONFIG
246
247 config: scripts_basic symlinks FORCE
248         $(Q)mkdir -p include/config
249         $(Q)$(MAKE) $(build)=scripts/kconfig $@
250
251 %config: scripts_basic symlinks FORCE
252         $(Q)mkdir -p include/config
253         $(Q)$(MAKE) $(build)=scripts/kconfig $@
254
255 else
256 # ===========================================================================
257 # Build targets only - this includes vmlinux, arch specific targets, clean
258 # targets and others. In general all targets except *config targets.
259
260 ifeq ($(dot-config),1)
261 KCONFIG_CONFIG ?= .config
262 export KCONFIG_CONFIG
263
264 # Read in config
265 -include include/config/auto.conf
266
267 # Read in dependencies to all Kconfig* files, make sure to run
268 # oldconfig if changes are detected.
269 -include include/config/auto.conf.cmd
270
271 # To avoid any implicit rule to kick in, define an empty command
272 $(KCONFIG_CONFIG) include/config/auto.conf.cmd: ;
273
274 # If .config is newer than include/config/auto.conf, someone tinkered
275 # with it and forgot to run make oldconfig.
276 # if auto.conf.cmd is missing then we are probably in a cleaned tree so
277 # we execute the config step to be sure to catch updated Kconfig files
278 include/config/%.conf: $(KCONFIG_CONFIG) include/config/auto.conf.cmd
279         $(Q)$(MAKE) -f $(srctree)/Makefile silentoldconfig
280
281 else
282 # Dummy target needed, because used as prerequisite
283 include/config/auto.conf: ;
284 endif # $(dot-config)
285
286 # Akaros Build Environment
287 # =========================================================================
288 AKAROSINCLUDE   := -I$(srctree)/kern/include/
289
290 # CROSS_COMPILE is defined per-arch.  Each arch can set other makeflags, kbuild
291 # directories, etc. 
292 -include $(srctree)/kern/arch/$(ARCH)/Makefile
293
294 CC          := $(CROSS_COMPILE)gcc 
295 CPP         := $(CROSS_COMPILE)g++
296 AS          := $(CROSS_COMPILE)as
297 AR          := $(CROSS_COMPILE)ar
298 LD          := $(CROSS_COMPILE)ld
299 OBJCOPY := $(CROSS_COMPILE)objcopy
300 OBJDUMP := $(CROSS_COMPILE)objdump
301 NM          := $(CROSS_COMPILE)nm
302 STRIP   := $(CROSS_COMPILE)strip
303 KERNEL_LD ?= kernel.ld
304
305 # These may have bogus values if there is no compiler.  The kernel and user
306 # build targets will check cc-exists.  Hopefully no cleaning targets rely on
307 # these.  Note that if you change configs, these will get computed once, before
308 # silentoldconfig kicks in to regenerate auto.conf, and these values will
309 # temporarily be stale.
310 gcc-lib := $(shell $(CC) -print-libgcc-file-name 2>/dev/null)
311 NOSTDINC_FLAGS += -nostdinc -isystem \
312                   $(shell $(CC) -print-file-name=include 2>/dev/null)
313 XCC_TARGET_ROOT := $(shell $(CC) --print-sysroot 2> /dev/null)
314 ifeq ($(XCC_TARGET_ROOT),)
315         XCC_TARGET_ROOT := $(dir $(shell which $(CC) 2> \
316                            /dev/null))../$(patsubst %-,%, $(CROSS_COMPILE))
317         XCC_TARGET_LIB := $(XCC_TARGET_ROOT)/lib/
318         XCC_TARGET_INCLUDE := $(XCC_TARGET_ROOT)/sys-include/
319 else
320         XCC_TARGET_LIB := $(XCC_TARGET_ROOT)/usr/lib/
321         XCC_TARGET_INCLUDE := $(XCC_TARGET_ROOT)/usr/include/
322 endif
323
324 CFLAGS_KERNEL += -O2 -pipe -MD
325 CFLAGS_KERNEL += -std=gnu99 -fgnu89-inline
326 CFLAGS_KERNEL += -fno-strict-aliasing -fno-omit-frame-pointer
327 CFLAGS_KERNEL += -fno-stack-protector
328 CFLAGS_KERNEL += -Wall -Wno-format -Wno-unused
329 CFLAGS_KERNEL += -DROS_KERNEL 
330 CFLAGS_KERNEL += -include include/generated/autoconf.h -include include/common.h
331 CFLAGS_KERNEL += -fplan9-extensions
332 ifeq ($(CONFIG_64BIT),y)
333 CFLAGS_KERNEL += -m64 -g
334 else
335 CFLAGS_KERNEL += -m32 -gstabs
336 endif
337
338 # TODO: do we need this, or can we rely on the compiler's defines?
339 CFLAGS_KERNEL += -D$(ARCH)
340
341 # TODO: this requires our own strchr (kern/src/stdio.c), which is a potential
342 # source of bugs/problems.
343 # note we still pull in stdbool and stddef from the compiler
344 CFLAGS_KERNEL += -fno-builtin
345
346 AFLAGS_KERNEL := $(CFLAGS_KERNEL)
347
348 KBUILD_BUILTIN := 1
349 KBUILD_CHECKSRC := 0
350
351 export AKAROSINCLUDE CROSS_COMPILE
352 export CC CPP AS AR LD OBJCOPY OBJDUMP NM STRIP
353 export CFLAGS_KERNEL AFLAGS_KERNEL
354 export NOSTDINC_FLAGS XCC_TARGET_ROOT XCC_TARGET_LIB XCC_TARGET_INCLUDE
355 export KBUILD_BUILTIN KBUILD_CHECKSRC
356
357 CFLAGS_USER += -O2 -std=gnu99 -fno-stack-protector -fgnu89-inline
358 CXXFLAGS_USER += -O2
359
360 export CFLAGS_USER CXXFLAGS_USER
361
362 # Akaros include stuff (includes custom make targets and user overrides)
363 # =========================================================================
364
365 # The user can override this, though it won't apply for any of the in-tree
366 # kernel build output.  Right now, it's only passed down to tests/
367 dummy-1 := $(shell mkdir -p $(OBJDIR)/kern/)
368
369 # Don't need to export these, since the Makelocal is included.
370 KERNEL_OBJ := $(OBJDIR)/kern/akaros-kernel
371 CMP_KERNEL_OBJ := $(KERNEL_OBJ).gz
372
373 # Since we're doing this outside of the dot-config part, some targets, such as
374 # clean, won't read in our .config/auto.conf, and won't know about the
375 # KFS_PATH.  Future rules related to KFS will have issues (mkdir with no
376 # argument, or a find of the entire pwd).  It's also possible someone provided
377 # an empty path.  To deal with both, we'll just have a sensible default.
378 kfs-paths :=  $(subst $\",,$(CONFIG_KFS_PATHS))
379 ifeq ($(kfs-paths),)
380 kfs-paths := kern/kfs
381 endif
382
383 FIRST_KFS_PATH = $(firstword $(kfs-paths))
384
385 export OBJDIR FIRST_KFS_PATH
386
387 # Avoiding implicit rules
388 $(srctree)/Makelocal: ;
389 # TODO: one issue is that we import all types of targets: build, clean, etc.
390 # That makes it a bit tougher to reorganize with ifeqs.
391 -include $(srctree)/Makelocal
392
393 # Akaros Kernel Build
394 # =========================================================================
395 # Add top level directories, either to an existing entry (core-y) or to its
396 # own. 
397 #
398 # From these, we determine deps and dirs.  We recursively make through the
399 # dirs, generating built-in.o at each step, which are the deps from which we
400 # link akaros.
401 #
402 # We have all-arch-dirs and all-dirs, so that we can still clean even without
403 # an arch symlink.
404
405 core-y += kern/src/ kern/drivers/ $(AKAROS_EXTERNAL_DIRS)
406 arch-y += kern/arch/$(ARCH)/
407
408 akaros-dirs     := $(patsubst %/,%,$(filter %/, $(core-y) $(arch-y)))
409
410 all-arch-dirs   := $(patsubst %,kern/arch/%/,$(valid-arches))
411 akaros-all-dirs := $(patsubst %/,%,$(filter %/, $(core-y) $(all-arch-dirs)))
412
413 core-y          := $(patsubst %/, %/built-in.o, $(core-y))
414 arch-y          := $(patsubst %/, %/built-in.o, $(arch-y))
415
416 kbuild_akaros_main := $(core-y) $(arch-y)
417 akaros-deps := $(kbuild_akaros_main)  kern/arch/$(ARCH)/$(KERNEL_LD)
418
419 kern_cpio := $(OBJDIR)/kern/initramfs.cpio
420 kern_cpio_obj := $(kern_cpio).o
421
422 # ext2 will crash at runtime if we don't have a block device.  try to catch the
423 # errors now.  if it is a bad one, you're just out of luck.
424 ifneq ($(CONFIG_EXT2FS),)
425 ext2-bdev := $(patsubst "%",%,$(CONFIG_EXT2_BDEV))
426 ifeq ($(ext2-bdev),)
427 $(error EXT2 selected with no block device [$(ext2-bdev)], fix your .config)
428 endif
429 ext2_bdev_obj = $(OBJDIR)/kern/$(shell basename $(ext2-bdev)).o
430 endif
431
432 # a bit hacky: we want to make sure the directories exist, and error out
433 # otherwise.  we also want to error out before the initramfs target, otherwise
434 # we might not get the error (if initramfs files are all up to date).  the
435 # trickiest thing here is that kfs-paths-check could be stale and require an
436 # oldconfig.  running make twice should suffice.
437 kfs-paths-check := $(shell for i in $(kfs-paths); do \
438                                if [ ! -d "$$i" ]; then \
439                                    echo "Can't find KFS directory $$i"; \
440                                        $(MAKE) -f $(srctree)/Makefile \
441                                                                            silentoldconfig > /dev/null; \
442                                    exit -1; \
443                                fi; \
444                            done; echo "ok")
445
446 ifneq (ok,$(kfs-paths-check))
447 $(error $(kfs-paths-check), try make one more time in case of stale configs)
448 endif
449
450 kern_initramfs_files := $(shell find $(kfs-paths))
451
452 # Need to make an empty cpio, then append each kfs-path's contents
453 $(kern_cpio) initramfs: $(kern_initramfs_files)
454         @echo "  Building initramfs:"
455         @if [ "$(CONFIG_KFS_CPIO_BIN)" != "" ]; then \
456         sh $(CONFIG_KFS_CPIO_BIN); \
457     fi
458         @cat /dev/null | cpio --quiet -oH newc -O $(kern_cpio)
459         $(Q)for i in $(kfs-paths); do cd $$i; \
460         echo "    Adding $$i to initramfs..."; \
461         find -L . | cpio --quiet -oAH newc -O $(CURDIR)/$(kern_cpio); \
462         cd $$OLDPWD; \
463     done;
464
465 ld_emulation = $(shell $(OBJDUMP) -i | grep -v BFD | grep ^[a-z] |head -n1)
466 ld_arch = $(shell $(OBJDUMP) -i | grep -v BFD | grep "^  [a-z]" | head -n1)
467
468 # Our makefile doesn't detect a change in subarch, and old binary objects that
469 # don't need to be updated won't get rebuilt, but they also can't link with the
470 # new subarch (32 bit vs 64 bit).  If we detect the wrong type, we'll force a
471 # rebuild.
472 existing-cpio-emul := $(shell objdump -f $(kern_cpio_obj) 2> /dev/null | \
473                         grep format | sed 's/.*format //g')
474 ifneq ($(existing-cpio-emul),)
475 ifneq ($(existing-cpio-emul),$(ld_emulation))
476 $(kern_cpio_obj): cpio-rebuild
477 cpio-rebuild:
478         $(Q)rm $(kern_cpio_obj)
479 endif
480 endif
481
482 $(kern_cpio_obj): $(kern_cpio)
483         $(Q)$(OBJCOPY) -I binary -B $(ld_arch) -O $(ld_emulation) $< $@
484
485 existing-ext2b-emul := $(shell objdump -f $(kern_cpio_obj) 2> /dev/null | \
486                          grep format | sed 's/.*format //g')
487 ifneq ($(existing-ext2b-emul),)
488 ifneq ($(existing-ext2b-emul),$(ld_emulation))
489 $(ext2_bdev_obj): ext2b-rebuild
490 ext2b-rebuild:
491         $(Q)rm $(ext2_bdev_obj)
492 endif
493 endif
494
495 $(ext2_bdev_obj): $(ext2-bdev)
496         $(Q)$(OBJCOPY) -I binary -B $(ld_arch) -O $(ld_emulation) $< $@
497
498 # Not the worlds most elegant link command.  link-kernel takes the obj output
499 # name, then the linker script, then everything else you'd dump on the ld
500 # command line, including linker options and objects to link together.
501
502 # After the script is done, we run the arch-specific command directly.
503 quiet_cmd_link-akaros = LINK    $@
504       cmd_link-akaros = $(CONFIG_SHELL) scripts/link-kernel.sh $@ \
505                         kern/arch/$(ARCH)/$(KERNEL_LD) $(LDFLAGS_KERNEL) \
506                         $(akaros-deps) $(gcc-lib) $(kern_cpio_obj) \
507                         $(ext2_bdev_obj); \
508                         $(ARCH_POST_LINK_CMD)
509
510 # For some reason, the if_changed doesn't work with FORCE (like it does in
511 # Linux).  It looks like it can't find the .cmd file or something (also
512 # complaints of $(targets), so that all is probably messed up).
513 $(KERNEL_OBJ): $(akaros-deps) $(kern_cpio_obj) $(ext2_bdev_obj)
514         $(call if_changed,link-akaros)
515
516 akaros-kernel: $(KERNEL_OBJ)
517
518 $(sort $(akaros-deps)): $(akaros-dirs) ;
519
520 # Recursively Kbuild all of our directories.  If we're changing arches
521 # mid-make, we might have issues ( := on akaros-dirs, etc).
522 PHONY += $(akaros-dirs) cc_exists
523 $(akaros-dirs): scripts symlinks cc-exists
524         $(Q)$(MAKE) $(build)=$@
525
526 cc-exists:
527         @if [ "`which $(CROSS_COMPILE)gcc`" = "" ]; then echo \
528             Could not find a $(CROSS_COMPILE) version of GCC/binutils. \
529             Be sure to build the cross-compiler and update your PATH; exit 1; fi
530
531 $(CMP_KERNEL_OBJ): $(KERNEL_OBJ)
532         @echo "Compressing kernel image"
533         $(Q)gzip -c $^ > $@
534
535 # TODO: not sure what all we want to have available for config targets
536 # (anything after this is allowed.  We currently need clean targets available
537 # (config->symlinks->clean).
538 endif #ifeq ($(config-targets),1)
539 endif #ifeq ($(mixed-targets),1)
540
541 # Akaros Userspace Building and Misc Helpers
542 # =========================================================================
543 # Recursively make user libraries and tests.
544 #
545 # User library makefiles are built to expect to be called from their own
546 # directories.  The test code can be called from the root directory.
547
548 # List all userspace directories here, and state any dependencies between them,
549 # such as how pthread depends on parlib.
550
551 user-dirs = parlib pthread benchutil iplib ndblib bsd
552 benchutil: parlib
553 pthread: parlib benchutil
554 iplib: parlib
555 ndblib: iplib
556 bsd: parlib iplib
557
558 PHONY += install-libs $(user-dirs)
559 install-libs: $(user-dirs) symlinks cc-exists
560
561 $(user-dirs):
562         @cd user/$@ && $(MAKE) DEPLIBS="$^" && $(MAKE) install
563
564
565 PHONY += userclean $(clean-user-dirs)
566 clean-user-dirs := $(addprefix _clean_user_,$(user-dirs))
567 userclean: $(clean-user-dirs) testclean utestclean
568
569 $(clean-user-dirs):
570         @cd user/$(patsubst _clean_user_%,%,$@) && $(MAKE) clean
571
572 tests/: tests
573 tests: install-libs
574         @$(MAKE) -f tests/Makefile
575
576 PHONY += utest
577 utest: $(user-dirs)
578         @cd user/$@ && $(MAKE) 
579
580 testclean:
581         @$(MAKE) -f tests/Makefile clean
582
583 utestclean:
584         @cd user/utest && $(MAKE) clean
585
586 # KFS related stuff
587 PHONY += fill-kfs unfill-kfs
588 XCC_SO_FILES = $(addprefix $(XCC_TARGET_ROOT)/lib/, *.so*)
589
590 $(OBJDIR)/.dont-force-fill-kfs:
591         $(Q)rm -rf $(addprefix $(FIRST_KFS_PATH)/lib/, $(notdir $(XCC_SO_FILES)))
592         @echo "Cross Compiler 'so' files removed from KFS"
593         @$(MAKE) -f tests/Makefile uninstall
594         @echo "Apps from /test removed from KFS"
595         @cd user/utest && $(MAKE) uninstall
596         @echo "User space tests removed from KFS"
597         @touch $(OBJDIR)/.dont-force-fill-kfs
598
599 fill-kfs: $(OBJDIR)/.dont-force-fill-kfs install-libs
600         @mkdir -p $(FIRST_KFS_PATH)/lib
601         $(Q)cp -uP $(XCC_SO_FILES) $(FIRST_KFS_PATH)/lib
602         @echo "Cross Compiler 'so' files installed to KFS"
603         @$(MAKE) -f tests/Makefile install
604         @echo "Apps from /test installed to KFS"
605         @cd user/utest && $(MAKE) install
606         @echo "User space tests installed to KFS"
607
608 # Use doxygen to make documentation for ROS (Untested since 2010 or so)
609 doxygen-dir := $(CUR_DIR)/Documentation/doxygen
610 docs: 
611         @echo "  Making doxygen"
612         @doxygen-dir=$(doxygen-dir) doxygen $(doxygen-dir)/rosdoc.cfg
613         @if [ ! -d $(doxygen-dir)/rosdoc/html/img ]; \
614          then \
615                 ln -s ../../img $(doxygen-dir)/rosdoc/html; \
616          fi
617
618 doxyclean:
619         @echo + clean [ROSDOC]
620         @rm -rf $(doxygen-dir)/rosdoc
621
622 objclean:
623         @echo + clean [OBJDIR]
624         @rm -rf $(OBJDIR)
625
626 realclean: userclean mrproper doxyclean objclean
627
628 # Cleaning
629 # =========================================================================
630 # This is mostly the Linux kernel cleaning.  We could hook in to the userspace
631 # cleaning with the 'userclean' target attached to clean, though historically
632 # 'clean' means the kernel.
633
634 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=dir
635 # Usage:
636 # $(Q)$(MAKE) $(clean)=dir
637 clean := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.clean obj
638
639 # clean - Delete all generated files
640 #
641 clean-dirs         := $(addprefix _clean_,$(akaros-all-dirs))
642
643 PHONY += $(clean-dirs) clean
644 $(clean-dirs):
645         $(Q)$(MAKE) $(clean)=$(patsubst _clean_%,%,$@)
646
647 RCS_FIND_IGNORE := \( -name SCCS -o -name BitKeeper -o -name .svn -o -name CVS \
648                    -o -name .pc -o -name .hg -o -name .git \) -prune -o
649 clean: $(clean-dirs)
650         @find $(patsubst _clean_%,%,$(clean-dirs)) $(RCS_FIND_IGNORE) \
651             \( -name '*.[oas]' -o -name '*.ko' -o -name '.*.cmd' \
652             -o -name '*.ko.*' \
653             -o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \
654             -o -name '*.symtypes' -o -name 'modules.order' \
655             -o -name modules.builtin -o -name '.tmp_*.o.*' \
656             -o -name '*.gcno' \) -type f -print | xargs rm -f
657
658 # Could add in an archclean if we need arch-specific cleanup, or a userclean if
659 # we want to start cleaning that too.
660 #clean: archclean
661 #clean: userclean
662
663 # mrproper - Delete all generated files, including .config, and reset ARCH
664 #
665 mrproper-dirs      := $(addprefix _mrproper_,scripts)
666
667 PHONY += $(mrproper-dirs) mrproper
668 $(mrproper-dirs):
669         $(Q)$(MAKE) $(clean)=$(patsubst _mrproper_%,%,$@)
670
671 mrproper: $(mrproper-dirs) clean clean_symlinks
672         @-rm -f .config
673         @find $(patsubst _mrproper_%,%,$(mrproper-dirs)) $(RCS_FIND_IGNORE) \
674             \( -name '*.[oas]' -o -name '*.ko' -o -name '.*.cmd' \
675             -o -name '*.ko.*' \
676             -o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \
677             -o -name '*.symtypes' -o -name 'modules.order' \
678             -o -name modules.builtin -o -name '.tmp_*.o.*' \
679             -o -name '*.gcno' \) -type f -print | xargs rm -f
680
681 # Epilogue
682 # =========================================================================
683
684 PHONY += FORCE
685 FORCE:
686
687 # Don't put the srctree on this, make is looking for Makefile, not
688 # /full/path/to/Makefile.
689 Makefile: ; # avoid implicit rule on Makefile
690
691 # Declare the contents of the .PHONY variable as phony.  We keep that
692 # information in a variable so we can use it in if_changed and friends.
693 .PHONY: $(PHONY)