Skip to content

Commit

Permalink
Update the README (add clang support)
Browse files Browse the repository at this point in the history
  • Loading branch information
@a13xp0p0v
a13xp0p0v committed Sep 4, 2021
1 parent d05f7f1 commit 60b8d5e
Showing 1 changed file with 48 additions and 40 deletions.
88 changes: 48 additions & 40 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ This project provides Docker containers for building the Linux kernel (or other

It's very useful for testing gcc-plugins for the Linux kernel, for example. Goodbye headache!

__Supported build targets:__
- `x86_64`
- `i386`
- `aarch64`

__Supported gcc versions:__
- gcc-4.8
- gcc-4.8 (doesn't support `gcc-plugins` for `aarch64`)
- gcc-5
- gcc-6
- gcc-7
Expand All @@ -14,14 +19,8 @@ __Supported gcc versions:__
- gcc-10
- gcc-11

__Supported build targets:__
- `x86_64`
- `i386`
- `aarch64`

__Exception:__ `gcc-4.8` for `aarch64` doesn't support `gcc-plugins`.

__Idea for future:__ add Clang.
__Supported clang versions:__
- clang-12

# Usage

Expand All @@ -35,14 +34,15 @@ Created containers:

```console
$ sudo docker image list | grep kernel-build-container
kernel-build-container gcc-11 aff1d980db1f 15 minutes ago 1.53GB
kernel-build-container gcc-10 923481cb3d94 2 months ago 852MB
kernel-build-container gcc-9 a15605755586 2 months ago 561MB
kernel-build-container gcc-8 44a10601240d 2 months ago 764MB
kernel-build-container gcc-7 f6fa0a1ece58 2 months ago 519MB
kernel-build-container gcc-6 242af7de9933 2 months ago 692MB
kernel-build-container gcc-5 ba9cd1de31f5 2 months ago 545MB
kernel-build-container gcc-4.8 5948f3cd8839 2 months ago 664MB
kernel-build-container clang-12 c5ad7aa4a0fc 21 seconds ago 1.85GB
kernel-build-container gcc-11 e65b58c480f9 4 minutes ago 1.53GB
kernel-build-container gcc-10 2243b6eaf166 8 minutes ago 894MB
kernel-build-container gcc-9 068a717867f2 11 minutes ago 596MB
kernel-build-container gcc-8 df138141c4df 13 minutes ago 799MB
kernel-build-container gcc-7 cd561a018382 16 minutes ago 523MB
kernel-build-container gcc-6 78f4984bd3d1 18 minutes ago 697MB
kernel-build-container gcc-5 69697e5835e6 20 minutes ago 545MB
kernel-build-container gcc-4.8 8ee1148c1728 22 minutes ago 664MB
```

### Running a container
Expand All @@ -59,23 +59,25 @@ usage: ./start_container.sh compiler src_dir out_dir [-n] [cmd with args]
Run interactive bash in the container:

```console
$ sh start_container.sh gcc-8 ~/linux/linux/ ~/linux/build_out/
$ sh start_container.sh gcc-10 ~/linux/linux/ ~/linux/build_out/
Hey, we gonna use sudo for running docker
Starting "kernel-build-container:gcc-8"
Starting "kernel-build-container:gcc-10"
Source code directory "/home/a13x/linux/linux/" is mounted at "~/src"
Build output directory "/home/a13x/linux/build_out/" is mounted at "~/out"
Run docker in interactive mode
Gonna run interactive bash...
```

Execute a command in the container:

```console
$ sh start_container.sh gcc-8 ~/linux/linux/ ~/linux/build_out/ gcc -v
$ sh start_container.sh clang-12 ~/linux/linux/ ~/linux/build_out/ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- CC=clang defconfig
Hey, we gonna use sudo for running docker
Starting "kernel-build-container:gcc-8"
Starting "kernel-build-container:clang-12"
Source code directory "/home/a13x/linux/linux/" is mounted at "~/src"
Build output directory "/home/a13x/linux/build_out/" is mounted at "~/out"
Gonna run "gcc -v"
Run docker in interactive mode
Gonna run "make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- CC=clang defconfig"
```

### Building Linux kernel
Expand All @@ -85,14 +87,13 @@ Get help:
```console
$ python3 make_linux.py -h
usage: make_linux.py [-h] -a {x86_64,i386,aarch64} -k kconfig -s src -o out -c
{gcc-4.8,gcc-5,gcc-6,gcc-7,gcc-8,gcc-9,gcc-10,gcc-11,all}
{gcc-4.8,gcc-5,gcc-6,gcc-7,gcc-8,gcc-9,gcc-10,gcc-11,clang-12,all}
...

Build Linux kernel using kernel-build-containers

positional arguments:
... additional arguments for 'make', can be separated by
'--' delimeter
... additional arguments for 'make', can be separated by -- delimiter

optional arguments:
-h, --help show this help message and exit
Expand All @@ -101,42 +102,49 @@ optional arguments:
-k kconfig path to kernel kconfig file
-s src Linux kernel sources directory
-o out Build output directory
-c {gcc-4.8,gcc-5,gcc-6,gcc-7,gcc-8,gcc-9,gcc-10,gcc-11,all}
-c {gcc-4.8,gcc-5,gcc-6,gcc-7,gcc-8,gcc-9,gcc-10,gcc-11,clang-12,all}
building compiler ('all' to build with each of them)
```

Kernel building example:

```console
$ python3 make_linux.py -a aarch64 -k ~/linux/experiment.config -s ~/linux/linux -o ~/linux/build_out -c gcc-8 -- -j5
$ python3 make_linux.py -a aarch64 -k ~/linux/experiment.config -s ~/linux/linux -o ~/linux/build_out -c clang-12 -- -j5
[+] Going to build the Linux kernel for aarch64
[+] Using "/home/a13x/linux/experiment.config" as kernel config
[+] Using "/home/a13x/linux/linux" as Linux kernel sources directory
[+] Using "/home/a13x/linux/build_out" as build output directory
[+] Going to build with: gcc-8
[+] Going to build with: clang-12
[+] Have additional arguments for 'make': -j5

=== Building with gcc-8 ===
Output subdirectory for this build: /home/a13x/linux/build_out/experiment__aarch64__gcc-8
Output subdirectory doesn't exist, create it
=== Building with clang-12 ===
Output subdirectory for this build: /home/a13x/linux/build_out/experiment__aarch64__clang-12
Output subdirectory already exists, use it (no cleaning!)
Copy kconfig to output subdirectory as ".config"
Going to save build log to "build_log.txt" in output subdirectory
Create additional arguments for cross-compilation: ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu-
Run the container: bash ./start_container.sh gcc-8 /home/a13x/linux/linux /home/a13x/linux/build_out/experiment__aarch64__gcc-8 -n make O=~/out/ ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j5 2>&1
Compiling with clang requires 'CC=clang'
Add arguments for cross-compilation: ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu-
Run the container: bash ./start_container.sh clang-12 /home/a13x/linux/linux /home/a13x/linux/build_out/experiment__aarch64__clang-12 -n make O=~/out/ CC=clang ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j5 2>&1
Hey, we gonna use sudo for running docker
Starting "kernel-build-container:gcc-8"
Starting "kernel-build-container:clang-12"
Source code directory "/home/a13x/linux/linux" is mounted at "~/src"
Build output directory "/home/a13x/linux/build_out/experiment__aarch64__gcc-8" is mounted at "~/out"
Build output directory "/home/a13x/linux/build_out/experiment__aarch64__clang-12" is mounted at "~/out"
Run docker in NON-interactive mode
Gonna run "make O=~/out/ ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j5 2>&1"
Gonna run "make O=~/out/ CC=clang ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j5 2>&1"
make[1]: Entering directory '/home/a13x/out'
SYNC include/config/auto.conf.cmd
GEN Makefile
HOSTCC scripts/basic/fixdep
HOSTCC scripts/kconfig/conf.o
...
Running the container returned 0
See build log: /home/a13x/linux/build_out/experiment__aarch64__gcc-8/build_log.txt
make[1]: Leaving directory '/home/a13x/out'
The container returned 0
See build log: /home/a13x/linux/build_out/experiment__aarch64__clang-12/build_log.txt
Only remove the container id file:
Hey, we gonna use sudo for running docker
Search "container.id" file in build output directory "/home/a13x/linux/build_out/experiment__aarch64__clang-12"
OK, "container.id" file exists, removing it
OK, container 48a25a340a1ceb3d1ee4baa4eafb1b44ad98c6a70bd105f0376cffb2ba21bd2e doesn't run
Finished with the container

[+] Done, see the results
```
Expand Down

0 comments on commit 60b8d5e

Please sign in to comment.