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