xnu-2050.24.15.tar.gz

[apple/xnu.git] / README

diff --git a/README b/README
index 9ab5b012d8d964afedfa405ce815f02804ac9cb5..b71d70f725114ca3c443bedbc1c7b7d4445c4e06 100644 (file)
--- a/README
+++ b/README
@@ -15,36 +15,17 @@ A. How to build XNU:
 
   By default, architecture defaults to the build machine 
   architecture, and the kernel configuration is set to build for DEVELOPMENT.
 
   By default, architecture defaults to the build machine 
   architecture, and the kernel configuration is set to build for DEVELOPMENT.

-  The machine configuration defaults to MX31ADS for arm and nothing for i386 and ppc.

   
   This will also create a bootable image, mach_kernel,  and a kernel binary 
   with symbols, mach_kernel.sys.
 
   
   This will also create a bootable image, mach_kernel,  and a kernel binary 
   with symbols, mach_kernel.sys.
 

-  Here are the valid arm machine configs:
-       LN2410SBC MX31ADS INTEGRATORCP S5I3000SMDK S5L8900XFPGA S5L8900XRB
-       OLOCREEK
-       
-  Examples:
-       /* make a debug kernel for MX31 arm board */
-       make TARGET_CONFIGS="debug arm MX31ADS"
-       
-    $(OBJROOT)/DEBUG_ARM_MX31ADS/osfmk/DEBUG/osfmk.o: pre-linked object for osfmk component
-    $(OBJROOT)/DEBUG_ARM_MX31ADS/mach_kernel: bootable image
-
-       /* make debug and development kernels for MX31 arm board */
-       make TARGET_CONFIGS="debug arm MX31ADS  development arm MX31ADS"
-       
-    $(OBJROOT)/DEBUG_ARM_MX31ADS/osfmk/DEBUG/osfmk.o: pre-linked object for osfmk component
-    $(OBJROOT)/DEBUG_ARM_MX31ADS/mach_kernel: bootable image
-    $(OBJROOT)/DEVELOPMENT_ARM/osfmk/DEVELOPMENT/osfmk.o: pre-linked object for osfmk component
-    $(OBJROOT)/DEVELOPMENT_ARM/mach_kernel: bootable image

 
 

-       /* this is all you need to do to build MX31ADS arm with DEVELOPMENT kernel configuration  */
-       make TARGET_CONFIGS="default arm default"
+       /* this is all you need to do to build with RELEASE kernel configuration  */
+       make TARGET_CONFIGS="release x86_64 default" SDKROOT=/path/to/SDK

        
        

-       or the following is equivalent
+       or the following is equivalent (ommitted SDKROOT will use /)

        
        

-       make ARCH_CONFIGS=ARM
+       make ARCH_CONFIGS=X86_64

 
 2) Building a Component
 
 
 2) Building a Component
 


@@ -68,7 +49,7 @@ A. How to build XNU:
   and KERNEL_CONFIGS).
   
   Example:
   and KERNEL_CONFIGS).
   
   Example:

-    $(OBJROOT)/RELEASE_PPC/osfmk/RELEASE/osfmk.o: pre-linked object for osfmk component
+    $(OBJROOT)/RELEASE_X86_64/osfmk/RELEASE/osfmk.filelist: list of objects in osfmk component

 
   From the component top directory:
 
 
   From the component top directory:
 


@@ -85,35 +66,36 @@ A. How to build XNU:
   Define kernel configuration to DEBUG in your environment or when running a 
   make command.  Then, apply procedures 4, 5
 
   Define kernel configuration to DEBUG in your environment or when running a 
   make command.  Then, apply procedures 4, 5
 

-  $ make TARGET_CONFIGS="DEBUG PPC DEFAULT" all
+  $ make TARGET_CONFIGS="DEBUG X86_64 DEFAULT" all

 
   or
 
 
   or
 

-  $ make KERNEL_CONFIGS=DEBUG all
+  $ make KERNEL_CONFIGS=DEBUG ARCH_CONFIGS=X86_64 all

 
   or
 
 
   or
 

-  $ export TARGET_CONFIGS="DEBUG ARM MX31ADS"
+  $ export TARGET_CONFIGS="DEBUG X86_64 DEFAULT"
+  $ export SDKROOT=/path/to/SDK

   $ make all
 
   Example:
   $ make all
 
   Example:

-    $(OBJROOT)/DEBUG_PPC/osfmk/DEBUG/osfmk.o: pre-linked object for osfmk component
-    $(OBJROOT)/DEBUG_PPC/mach_kernel: bootable image
+    $(OBJROOT)/DEBUG_X86_64/osfmk/DEBUG/osfmk.filelist: list of objects in osfmk component
+    $(OBJROOT)/DEBUG_X86_64/mach_kernel: bootable image

 
 4) Building fat
 
   Define architectures in your environment or when running a make command.
   Apply procedures 3, 4, 5
 
 
 4) Building fat
 
   Define architectures in your environment or when running a make command.
   Apply procedures 3, 4, 5
 

-  $ make TARGET_CONFIGS="RELEASE PPC default RELEASE I386 default" exporthdrs all
+  $ make TARGET_CONFIGS="RELEASE I386 DEFAULT RELEASE X86_64 DEFAULT" exporthdrs all

 
   or
 
 
   or
 

-  $ make ARCH_CONFIGS="PPC I386" exporthdrs all
+  $ make ARCH_CONFIGS="I386 X86_64" exporthdrs all

 
   or
 
 
   or
 

-  $ export ARCH_CONFIGS="PPC I386"
+  $ export ARCH_CONFIGS="I386 X86_64"

   $ make exporthdrs all
 
 5) Verbose make 
   $ make exporthdrs all
 
 5) Verbose make 


@@ -130,16 +112,30 @@ A. How to build XNU:
 
   From the top directory, run:
 
 
   From the top directory, run:
 

-    $ ~rc/bin/buildit . -arch ppc -arch i386 -noinstallsrc -nosum
-       
-       or for multiple arm builds
-       
-    $ ~rc/bin/buildit . -noinstallsrc -nosum -- TARGET_CONFIGS="release arm MX31ADS release arm LN2410SBC"
-       
-       or for default arm build (kernel config DEVELOPMENT and machine config MX31ADS)
-       
-    $ ~rc/bin/buildit . -arch arm -noinstallsrc -nosum -- TARGET_CONFIGS="release arm MX31ADS release arm LN2410SBC"
+    $ ~rc/bin/buildit . -arch i386 -arch x86_64 -arch armv7 -arch ppc -noinstallsrc -nosum
+

        
        

+  xnu supports a number of XBS build aliases, which allow B&I to build
+  the same source submission multiple times in different ways, to
+  produce different results. Each build alias supports the standard
+  "clean", "install", "installsrc", "installhdrs" targets, but
+  conditionalize their behavior on the RC_ProjectName make variable
+  which is passed as the -project argument to ~rc/bin/buildit, which
+  can be one of:
+
+  -project xnu          # the default, builds /mach_kernel, kernel-space
+                        # headers, user-space headers, man pages,
+                        # symbol-set kexts
+
+  -project xnu_debug    # a DEBUG kernel in /AppleInternal with dSYM
+
+  -project libkxld      # user-space version of kernel linker
+
+  -project libkmod     # static library automatically linked into kexts
+
+  -project Libsyscall   # automatically generate BSD syscall stubs
+
+

 
 8) Creating tags and cscope
 
 
 8) Creating tags and cscope
 


@@ -154,10 +150,20 @@ A. How to build XNU:
 
     $ make cscope      # this will build cscope database
 
 
     $ make cscope      # this will build cscope database
 

+9) Other makefile options
+
+   $ make MAKEJOBS=-j8    # this will use 8 processes during the build. The default is 2x the number of active cores
+
+   $ make -w              # trace recursive make invocations. Useful in combination with VERBOSE=YES
+
+   $ make BUILD_LTO=1    # build with LLVM Link Time Optimization (experimental)
+
+   $ make BUILD_INTEGRATED_ASSEMBLER=1 # build with LLVM integrated assembler (experimental)
+

 =============================================
 B. How to install a new header file from XNU
 
 =============================================
 B. How to install a new header file from XNU
 

-[Note: This does not covers installing header file in IOKit framework]
+[Note: This does not cover installing header files in IOKit framework]

 
 1) XNU installs header files at the following locations -
        a. $(DSTROOT)/System/Library/Frameworks/Kernel.framework/Headers
 
 1) XNU installs header files at the following locations -
        a. $(DSTROOT)/System/Library/Frameworks/Kernel.framework/Headers


@@ -200,7 +206,7 @@ B. How to install a new header file from XNU
 3) The Makefile combines the file lists mentioned above into different 
    install lists which are used by build system to install the header files.
 
 3) The Makefile combines the file lists mentioned above into different 
    install lists which are used by build system to install the header files.
 

-   If the install list that you are interested does not exists, create it
+   If the install list that you are interested does not exist, create it

    by adding the appropriate file lists.  The default install lists, its 
    member file lists and their default location are described below - 
 
    by adding the appropriate file lists.  The default install lists, its 
    member file lists and their default location are described below -