[REFERENCE] How to compile an Android kernel

Search This thread

ordinarykid23

Member
Dec 12, 2015
18
5
Aurora
Nathan I followed your steps and I succeeded on building my kernel and making the zip file. My problem now is I cant flash it, I keep getting errors. I tried to tar it and other methods but they are not working.
 

metalmouth

Senior Member
Jan 9, 2008
89
22
Lucena City
just got lucky today :D i had compile my kernel successfully its for Asus Zenfone 3 (snapdragon). I used AIK for unpacking and repacking unfortunately after flashing the image it doesn't boot :D it just redirects me to fastboot mode.
 

jordandroid64

Senior Member
Sep 7, 2014
327
36
Hey, first thanks for this tutorial.
Here is my problem, when I try to make clean (or same make 0=out clean), i've an error, I haven't understoop something in the earlier steps but i don't know what.
Screen which should show what i've done :
1516118120-screenshot-from-2018-01-16-16-49-54.png
 

nathanchance

Senior Recognized Developer / Contributor
Jul 22, 2015
13,760
50,106
29
Mesa, AZ
nathanchance.dev
Hey, first thanks for this tutorial.
Here is my problem, when I try to make clean (or same make 0=out clean), i've an error, I haven't understoop something in the earlier steps but i don't know what.
Screen which should show what i've done :
1516118120-screenshot-from-2018-01-16-16-49-54.png

You need to run the make commands in the root of your kernel source, not the configs folder.
 
  • Like
Reactions: jordandroid64

jordandroid64

Senior Member
Sep 7, 2014
327
36
Hey, so i've tried to compile this kernel (for Z2_row) : https://github.com/mracar07/android_kernel_zuk_msm8996/tree/8x-caf/
Unfortunately i've some errors when I compile, the defconfig file i've selected is : z2_row_defconfig but the file length is around 4400lines when if i am right generaly defconfig file (i've try to seen the length on some other kernels for other devices) are more around 600 lines. so Have I chosen the bad defconfig file ? (link: https://github.com/mracar07/android_kernel_zuk_msm8996/tree/8x-caf/arch/arm64/configs)
 

nathanchance

Senior Recognized Developer / Contributor
Jul 22, 2015
13,760
50,106
29
Mesa, AZ
nathanchance.dev
Hey, so i've tried to compile this kernel (for Z2_row) : https://github.com/mracar07/android_kernel_zuk_msm8996/tree/8x-caf/
Unfortunately i've some errors when I compile, the defconfig file i've selected is : z2_row_defconfig but the file length is around 4400lines when if i am right generaly defconfig file (i've try to seen the length on some other kernels for other devices) are more around 600 lines. so Have I chosen the bad defconfig file ? (link: https://github.com/mracar07/android_kernel_zuk_msm8996/tree/8x-caf/arch/arm64/configs)

That looks like the correct config, your errors are probably unrelated to that.

Most developers just copy the generated .config file to the configs folder, which is why it is really big. Other developers and companies choose to use the savedefconfig target so that instead of getting a giant defconfig, you get one that only has the values that were changed from the default. The kernel automatically fills in the gaps with the default values.
 
  • Like
Reactions: jordandroid64

leathan

Senior Member
Sep 15, 2013
211
48
Holy flippering buckets thank you on another level, I really needed that toolchain information to port some of my binaries :) pretty sure its all i need. tyty.
 
  • Like
Reactions: nathanchance

karthik km

Recognized Developer
Feb 18, 2015
1,493
2,066
29
Bangalore
My device having kernel source for nougat (msm8916)

Can any one tell me about
How to make my kernel source compatible with Oreo?

Any help highly appreciated

If the questions is already asked
Then please provide me a link

Thanks
 

antariksh

Senior Member
Feb 8, 2012
419
766
Mumbai
antariksh.dev
First thing first, Thanks for the guide.
Am new to development and have just started building ROMs. All I have worked till now is the device and vendor tree.
I just wanted to ask, if I can use the Stock Motorola kernel as a base for Lineage or AOSP ROMs. Are there any obvious changes I have to make for LOS or AOSP?

Provide any links to that (if exists), or simple Yes/No would also be fine for me to start digging up more information in right direction.
Thanks :D
 
If a device has a Oreo 8 or any other stock image , and you get root, or can download the OEM Rom image,

Can you extract the kernel and the build config?
Then build based on the build config?

kernelnewbies.org has instructions


If you're trying to see if a bug is fixed, you probably want to duplicate the configuration on your running kernel. That config file is stored somewhere in /boot/. There might be several files that start with config, so you want the one associated with your running kernel. You can find that by running

cp /boot/config-`uname -r`* .config


Edit. Any reason we can build a kernel on the rooted device? With shell root access?
 

Top Liked Posts

  • There are no posts matching your filters.
  • 1
    How can I compile a 5.x kernel using the 3.18 source? My device doesn’t have newer source.
    sorry I haven't tried, I'm also newbie. I will try first and may tell you if success
  • 240
    Introduction

    Hello everyone, I will be going over how to compile a kernel from beginning to end!

    Prerequisites:
    • A Linux environment (preferably 64-bit)
    • Knowledge of how to navigate the command line
    • Common sense
    • A learning spirit, there will be no spoonfeeding here

    What this guide will cover:
    1. Downloading the source
    2. Downloading a cross compiler
    3. Building the kernel
    4. Flashing the kernel

    What this guide will NOT cover:
    • Setting up a build environment (plenty of existing Linux installation guides)
    • Adding features to the kernel (plenty of git cherry-picking guides)

    I know this has been done before but on a cursory search, I have not seen a guide that was recently updated at all.


    1. Downloading the source


    If you have a custom kernel you want to build, move along after cloning the kernel using the git clone command below.

    If you are compiling your stock kernel, it is ultimately up to you to know where to get your kernel source from but here are some common places:

    Google: https://android.googlesource.com/kernel/msm/ (pick your architecture and look at the branches)
    LG: http://opensource.lge.com/index
    Samsung: http://opensource.samsung.com/reception.do
    HTC: https://www.htcdev.com/devcenter/downloads
    OnePlus: https://github.com/OnePlusOSS
    Motorola: https://github.com/MotorolaMobilityLLC
    Sony: https://github.com/sonyxperiadev/kernel

    To download the kernel, you can either use git clone or download the tarball and extract it:
    Code:
    git clone -b <branch_to_checkout> <url> <desired_folder_name>
    
    OR
    
    tar -xvf <filename>

    For example, if I wanted to grab the latest Nexus 6P from Google above:
    Code:
    git clone -b android-msm-angler-3.10-nougat-mr2 https://android.googlesource.com/kernel/msm/ angler
    This will clone the kernel/msm repo into an angler folder and checkout the android-msm-angler-3.10-nougat-mr2 automatically.

    I can try and help you locate your source if necessary.



    2. Downloading a cross compiler


    Since most Android devices are ARM based, we need a compiler that is targeting ARM devices. A host (or native) compiler will not work unless you are compiling on another ARM device.

    You can either compile one yourself if you know how (crosstool-NG is a great tool for this) or download a prebuilt one. Luckily Google provides a high quality toolchain for this, in both an arm (32-bit) and arm64 (64-bit). It's up to you to know the architecture of your device. Typically speaking, most devices in the past two-three years are 64-bit.

    Another popular toolchain is UberTC, which can be found here: https://bitbucket.org/matthewdalex/. Most kernels will need patches for anything higher than 4.9 and while I don't mind assisting with finding them, you should compile with Google's toolchain first.

    Once you have decided, clone the toolchain:
    Code:
    git clone <url>


    3. Compile the kernel


    1. Point the Makefile to your compiler (run this from within the toolchain folder!!)
    Code:
    export CROSS_COMPILE=$(pwd)/bin/<toolchain_prefix>-
    Example:
    Code:
    export CROSS_COMPILE=$(pwd)/bin/aarch64-linux-android-

    NOTE #1: For kernels that can be compiled with Clang (like the Pixel 2), see this guide. I will support it here if there are any questions.

    NOTE #2: Pixel and Pixel 2 users, you will need to follow these steps as well if compiling for Android Pie.

    2. Tell the Makefile the architecture of the device
    Code:
    export ARCH=<arch> && export SUBARCH=<arch>
    Example:
    Code:
    export ARCH=arm64 && export SUBARCH=arm64

    3. Locate your proper defconfig
    Navigate to the arch/<arch>/configs folder within the kernel source (e.g. arch/arm64/configs) and locate your device's or custom kernel developer's proper config file. For example, it will often be in the form of <codename>_defconfig or <kernel_name>_defconfig. Generic Qualcomm configs may be used as well (msm-perf_defconfig, msmcortex-perf_defconfig). When in doubt, ask here if you are confused. A defconfig tells the compiler what options to add to the kernel.

    4. Build the kernel

    Code:
    make clean
    make mrproper
    make <defconfig_name>
    make -j$(nproc --all)

    If those commands succeed, you will have an Image, Image-dtb, Image.gz, or Image.gz-dtb file at the end.

    If it failed, as was pointed out to me by @flar2 while making a complete idiot of myself, you may need to specify an output directory while making new CAF based kernels, like so:
    Code:
    mkdir -p out
    make O=out clean
    make O=out mrproper
    make O=out <defconfig_name>
    make O=out -j$(nproc --all)

    If after that something is still broken, you may need to fix some headers or other issues. If it is a custom kernel, bring it up with your developer.
    If it's an OEM, it's up to you to try and fix it, which we can assist with.



    4. Flash the kernel


    Assuming you were able to compile the kernel successfully, you now need to flash it! I will be covering two different ways to flash a compiled kernel: unpacking and repacking the boot image by hand using Android Image Kitchen or AnyKernel2, both by the brilliant @osm0sis. If there are any per-device nuances, please let me know and I'll add them here! Additionally, this section can vary drastically by device, you may need to consult developers of your device for assistance if necessary.

    Android Image Kitchen

    1. Pull your device's boot image from the latest image available for your device (whether it be a ROM or stock)
    2. Download the latest Android Image Kitchen from this thread.
    3. Run the following with the boot image:
      Code:
      unpackimg.sh <image_name>.img
    4. Locate the zImage file and replace it with your kernel image (rename it to what came out of the boot image)
    5. Run the following to repack:
      Code:
      repackimg.sh
    6. Flash the new boot image with fastboot or TWRP!

    AnyKernel2

    1. Download the latest AnyKernel2 zip: https://github.com/osm0sis/AnyKernel2/archive/master.zip
    2. Apply this patch to clean out all of the demo files:
      Code:
      wget https://github.com/nathanchance/AnyKernel2/commit/addb6ea860aab14f0ef684f6956d17418f95f29a.diff
      patch -p1 < addb6ea860aab14f0ef684f6956d17418f95f29a.diff
      rm addb6ea860aab14f0ef684f6956d17418f95f29a.diff
    3. Place your kernel image in the root of the file.
    4. Open the anykernel.sh file and modify the following values:
      • kernel.string: your kernel name
      • device.name#: List all of your device's codenames (from the /system/build.prop: ro.product.device, ro.build.product)
      • block: Your boot image's path in your fstab. The fstab can be opened from the root of your device and it will look something like this:
        https://android.googlesource.com/device/huawei/angler/+/master/fstab.angler
        The first column is the value you want to set block to.
    5. After that, zip up the kernel and flash it!
      Code:
      zip -r9 kernel.zip * -x README.md kernel.zip


    Tips and tricks


    1. Remove GCC wrapper

    A lot of kernels from CAF include a Python script that will essentially turn on -Werror, causing your build to error at the most benign stuff. This is necessary with higher GCC versions as there are a lot more warnings.

    Here is the diff of what you need to change in the Makefile:
    Code:
    diff --git a/Makefile b/Makefile
    index 1aaa760f255f..bfccd5594630 100644
    --- a/Makefile
    +++ b/Makefile
    @@ -326,7 +326,7 @@ include $(srctree)/scripts/Kbuild.include
    
     AS		= $(CROSS_COMPILE)as
     LD		= $(CROSS_COMPILE)ld
    -REAL_CC		= $(CROSS_COMPILE)gcc
    +CC		= $(CROSS_COMPILE)gcc
     CPP		= $(CC) -E
     AR		= $(CROSS_COMPILE)ar
     NM		= $(CROSS_COMPILE)nm
    @@ -340,10 +340,6 @@ DEPMOD		= /sbin/depmod
     PERL		= perl
     CHECK		= sparse
    
    -# Use the wrapper for the compiler.  This wrapper scans for new
    -# warnings and causes the build to stop upon encountering them.
    -CC		= $(srctree)/scripts/gcc-wrapper.py $(REAL_CC)
    -
     CHECKFLAGS     := -D__linux__ -Dlinux -D__STDC__ -Dunix -D__unix__ \
     		  -Wbitwise -Wno-return-void $(CF)
     CFLAGS_MODULE   =

    2. Using a higher level GCC toolchain

    Using a higher GCC toolchain (5.x, 6.x, 7.x or even 8.x) will require you to nuke the GCC wrapper script as above and use a unified GCC header file (pick the following if you have an include/linux/compiler-gcc#.h file):

    3.4/3.10: https://git.kernel.org/pub/scm/linu...h?id=a4a4f1cd733fe5b345db4e8cc19bb8868d562a8a
    3.18: https://git.kernel.org/pub/scm/linu...h?id=677fa15cd6d5b0843e7b9c58409f67d656b1ec2f

    You may get a lot of warnings but they are not entirely necessary to fix.


    3. Adding upstream Linux to kernel source

    Once you have gotten familiar with git and the compilation process, you should consider upstreaming your kernel. This will allow you to stay on top of CVE and bug fixes by staying up to date with the latest work of the Linux kernel developers.



    Receiving help

    I am happy to answer anything that I touched on in this guide. I may point you to another thread if it's better suited but I don't mind off topic (within reason) within the thread. I also want this to be a collaborative effort; other developers, if you have something to add, correct, or improve upon, please let me know!

    I am particular in how people ask for help. I do NOT respond to posts asking for a hand out ("How do I fix this?", "Please fix this!", etc.). I only respond to posts with clear logs and steps that you have tried. Basically, show me that you have read this guide and have a specific issue. I am not here to hold your hand through this, this is a developers' forum.
    20
    Compile Android Pie kernels for the Pixel (XL) and Pixel 2 (XL)

    Google added a new compat vDSO on Android Pie for 32-bit userspace, which requires a 32-bit toolchain (commit). As a result, if CROSS_COMPILE_ARM32 is not set, your build will error.

    After setting your main CROSS_COMPILE in step 1, clone this toolchain (or another compatible arm toolchain) next to the aarch64 one (if in the toolchain folder after running 'export CROSS_COMPILE', type 'cd ..'). Move into the 32-bit toolchain folder using cd then run
    Code:
    export CROSS_COMPILE_ARM32=$(pwd)/bin/<toolchain_prefix>
    Example:
    Code:
    export CROSS_COMPILE_ARM32=$(pwd)/bin/arm-linux-androideabi-

    Then continue on with the rest of the steps.
    9
    Introduction

    I am happy to answer anything that I touched on in this guide. I may point you to another thread if it's better suited but I don't mind off topic (within reason) within the thread. I also want this to be a collaborative effort; other developers, if you have something to add, correct, or improve upon, please let me know!

    I am particular in how people ask for help. I do NOT respond to posts asking for a hand out ("How do I fix this?", "Please fix this!", etc.). I only respond to posts with clear logs and steps that you have tried. Basically, show me that you have read this guide and have a specific issue. I am not here to hold your hand through this, this is a developers' forum.

    On a scale of 1-10 how much Off-Topic is allowed ? :highfive::laugh::silly::eek:





    Nice guide :good: :highfive: ..



    8
    @nathanchance thx for great work
    But how to build kernel with gcc 9.2.0
    could you please add manual for that

    Unfortunately, my time nowadays is limited between my job, school, and more important open source projects.

    However, compiling with GCC 9.2.0 is the same as compiling with GCC 4.9.4, you point the CROSS_COMPILE variable at the GCC 9.2.0 toolchain (or use PATH and update the CROSS_COMPILE prefix to match) and go from there. There are probably going to be new warnings that you will need to solve and there are potentially some other commits that you will need to pick to get a boot off.

    If anyone else wants to pitch in and write something up, I'd be happy to add it to the OP.
    7
    You're on fire with this kernel stuff:D

    Sent from my LEX727 using XDA Labs