Tutorial

チュートリアル環境を構築する †

好きにいじれる Linux kernel を用意する †

仮想環境を使い Linux kernel 内で動作するプログラムを作っていきます。ユーザー・ランドで動作するプログラムとの違い。Linux kernel の様子を探っていきます。ここでは linux で動作する VirtualBox を使用します。Windows で動作する VirtualBox も利用できます。Windows で動作する VirtualBox では不便な場面は有るかと思いますが、なるべく困らないようにしていきたいと思います。

仮想マシンを用意する †

仮想マシンを作成する †

VirtualBox に次のような設定の仮想マシンを用意してください。他の仮想環境を使う場合は、よく似た環境にしてください。

次は VirtualBox の仮想マシン設定一覧の画像です。赤線を引いたところは設定を必要とする項目です。

仮想マシンに Ubuntu をインストールする †

単純なパーティション構成で Ubuntu をインストールします。Installation Type にて Erase disk and install Ubuntu を選びます。

次の表のようにパーティションが分割されます。

次はパーティション分割を終えた後のスクリーン・ショットです。

パッケージ追加 †

私の好みも含め、パッケージを追加しデバイス・ドライバ開発に備えます。apt-get install を目的別に書いたので、お手数をおかけします。

• ssh server をインストールする

  $ sudo apt-get install ssh
  $ sudo service ssh start
  $ ifconfig  # IP アドレスを調べてリモートより操作する手掛かりを収集
  

• system V init ツールをインストールする

  $ sudo apt-get install sysv-rc-conf
  

• ssh server を常に起動しておく

  $ sudo sysv-rc-conf --level 2345 ssh on
  

• git ツールをインストールする

  $ sudo apt-get install git gitk git-gui
  $ sudo git config --global user.name "Your Name"  # Your Name の部分は英語で自分の名前にします。
  $ sudo git config --global user.email "your.email@example.com"  # your.email... の部分はメールアドレスら置き換えます。
  

• kernel source を make するのに必要なツールをインストールする
  curses ライブラリを使い、テキスト文字によって視覚的に把握しやすい画面を通してコンパイル条件を設定するために使います。

  $ sudo apt-get install libncurses-dev xmlto
  

  ノート

  git gui コマンドを使って GUI の git ツールを起動し、commit を行った人の名前、メールアドレスに加えスペルチェック機能も設定すると便利です。

• grub2 boot loader を更新するのに必要なツールをインストールする。
  

  $ sudo apt-get install grub2
  

• (好みで) NFS server をインストールする
  NFS server 機能を使うことでコンパイルをホスト・マシンなど早いコンピュータで行うことができます。

  $ sudo apt-get install nfs-kernel-server
  $ sudo service nfs-kernel-server on
  $ sudo sysv-rc-conf --level 2345 nfs-kernel-server on
  

  ノート

  設定ファイル /etc/exportfs を編集していないので NFS で共有するディレクトリはありません。 /etc/exportfs を編集した後、sudo service nfs-kernel-server reload で設定が有効になります。

• (好みで) samba server をインストールする

  $ sudo apt-get install samba winbind libnss-winbind
  $ sudo sysv-rc-conf --level 2345 nmb on
  $ sudo sysv-rc-conf --level 2345 smb on
  $ sudo sysv-rc-conf --level 2345 winbind on
  $ sudo nano /etc/samba/smb.conf  # samba 設定内容を好みに合わせて編集
  $ sudo nano /etc/nsswitch.conf  # hosts: 行に有る dns の前に wins を追加
  $ sudo service nmb start
  $ sudo service smb start
  $ sudo service winbind start
  

ソースを取ってくる †

Linux kernel のソースコードを取得します。ローカルの git リポジトリを置く場所を git_base_directory とします。ソース・コードを clone すると git_base_directory/linux-stable 以下に取得したファイルが配置されます。次に示す手順は、git_base_directory を作成することを前提としています。ホームディレクトリ直下に配置する場合は、git_base_directory を作成するコマンドは省略してもよいです。

$ mkdir -p git_base_directory
$ cd git_base_directory
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git

コンパイルができる様に準備する †

Ubuntu 14.04 に使っている Linux kernel よりは新しく、long term で更新されている kernel を選びます。これを書いている時点で 4.1.27 を選択しました。ローカルの git repository に 4.1.27-local branch を作成し作業を進めます。次のようにします。これより後、特に断りがなければ、先の節でソースコードが配置されたディレクトリ git_base_directory/linux-stable を単に linux-stable と表現します。

$ cd linux-stable
$ git checkout v4.1.27
$ git branch v4.1.27-local
$ git checkout v4.1.27-local

make menuconfig †

ソース・コード・ツリーの根にある .config ファイルの内容を make や gcc のマクロ定義値として読み込み、Linux kernel のソース・コードはコンパイルされます。.config ファイルに書かれた値を全て吟味していると、内容を把握していても数時間を要するでしょう。いずれ .config ファイルの内容のうちデバイス・ドライバ開発で興味深い部分に触れる予定です。今は、既にある .config ファイルを使ってソース・コードをコンパイルします。

$ cd linux-stable  # 前節の続きであれば不要です。
$ cp /boot/config-`uname -r` ./.config
$ make menuconfig

make menuconfigを実行すると次のような画面になります。すぐにコンパイルを始められるよう最低限の設定をして先に進みます。画面のスナップショットを全て示すのは大変なので、選択項目と入力内容を示しながら進めます。例えば "General setup" と書いた場合、次の画面の下線部分をカーソルキーで選択し [Enter] を押して選択することを意味します。

 .config - Linux/x86 4.1.27 Kernel Configuration
 ──────────────────────────────────────────────
  ┌── Linux/x86 4.1.27 Kernel Configuration  ──────────────────────┐
  │  Arrow keys navigate the menu.  <Enter> selects submenus ---> (or empty submenus       │
  │  ----).  Highlighted letters are hotkeys.  Pressing <Y> includes, <N> excludes, <M>    │
  │  modularizes features.  Press <Esc><Esc> to exit, <?> for Help, </> for Search.        │
  │  Legend: [*] built-in  [ ] excluded  <M> module  < > module capable                    │
  │ ┌────────────────────────────────────────┐   │
  │ │      [*] 64-bit kernel                                                         │   │
  │ │          General setup  --->                                                   │   │
  │ │      [*] Enable loadable module support  --->                                  │   │
  │ │      [*] Enable the block layer  --->                                          │   │
  │ │          Processor type and features  --->                                     │   │
  │ │          Power management and ACPI options  --->                               │   │
  │ │          Bus options (PCI etc.)  --->                                          │   │
  │ │          Executable file formats / Emulations  --->                            │   │
  │ │      [*] Networking support  --->                                              │   │
  │ │          Device Drivers  --->                                                  │   │
  │ │          Firmware Drivers  --->                                                │   │
  │ │          File systems  --->                                                    │   │
  │ │          Kernel hacking  --->                                                  │   │
  │ │          Security options  --->                                                │   │
  │ │      -*- Cryptographic API  --->                                               │   │
  │ │      -*- Virtualization  --->                                                  │   │
  │ │          Library routines  --->                                                │   │
  │ │                                                                                │   │
  │ └────────────────────────────────────────┘   │
  ├────────────────────────────────────────────┤
  │               <Select>    < Exit >    < Help >    < Save >    < Load >                 │
  └────────────────────────────────────────────┘

1. "General setup" -> "Local version - append to kernel release" -> テキスト入力ボックスが現れるので "-local" と入力します。
2. "< Ok >" と "< Exit >" を選択して menuconfig を抜ける操作をすると "Do you wish to save your new configuration?" というダイアログが現れるので "< Yes >" を選択します。menuconfig は終了します。

menuconfig を終えると linux-stable ディレクトリに .config と .config.old ファイルが出来上がります。差分を観察してみると、次の点に気づくでしょう。

• 何ケ所かで行の入れ替えがある。
• 新しい kernel で追加された機能に関係する値が設定されている。

menuconfig を使用すると、設定を一覧でき修正も楽です。しかし、変更点の追跡は困難になります。2, 3 項目の修正であれば .config あるいは *_defconfig *_defconfig の一覧) ファイルを直接修正して開発を進めるのが良いでしょう。

構築 †

おおよそプロセッサ数(同時実行可能な Thread 数) x 2 の並列度でコンパイルします。並列度の上限は「主記憶量 / 200Mbyte」程度にしてください。

$ make -j 4

起動するように組み込む †

make で構築したファイルは起動時にメモリ上に展開される kernel image、kernel に動的に組み込むことができる .ko ファイル(kernel object)、いくつかのデバッグ情報です。これらを組み込んでいきます。

$ sudo make modules_install  # .ko ファイルをインストールする
$ sudo make install  # kernel image をインストールする

上記の make コマンドで Linux kernel に組み込まれるモジュールと Linux kernel の起動イメージが次のようにインストールされます。

構築した Linux kernel を起動する様に grub2 boot loader を構成します。次のように grub.cfg ファイルを検索して、組み込まれた状態を確認します。手順通り進めていれば Linux 4.1.27-local と書かれた行が見つかるはずです。

$ grep -w menuentry /boot/grub/grub.cfg
        menuentry 'Ubuntu' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-simple-7e6711c8-fd4c-4b35-a16a-c04d37e7778c' {
        menuentry 'Ubuntu, with Linux 4.1.27-local' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.1.27-local-advanced-7e6711c8-fd4c-4b35-a16a-c04d37e7778c' {
        menuentry 'Ubuntu, with Linux 4.1.27-local (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.1.27-local-recovery-7e6711c8-fd4c-4b35-a16a-c04d37e7778c' {
        menuentry 'Ubuntu, with Linux 3.19.0-25-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-3.19.0-25-generic-advanced-7e6711c8-fd4c-4b35-a16a-c04d37e7778c' {
        menuentry 'Ubuntu, with Linux 3.19.0-25-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-3.19.0-25-generic-recovery-7e6711c8-fd4c-4b35-a16a-c04d37e7778c' {
menuentry 'Memory test (memtest86+)' {
menuentry 'Memory test (memtest86+, serial console 115200)' {

確認が済んだら、 /etc/default/grub を編集します。

$ sudo nano /etc/default/grub  # 好みのエディタを使用して下さい

構築した Linux kernel を起動する様に修正します。下線をつけた箇所が修正した行です。"Ubuntu>Ubuntu, with Linux 4.1.27-local" の部分は先ほど grep で見つかった行と違う箇所があります。'>' でメニューの階層構造を表現しています。

# If you change this file, run 'update-grub' afterwards to update
# /boot/grub/grub.cfg.
# For full documentation of the options in this file, see:
#   info -f grub -n 'Simple configuration'

GRUB_DEFAULT="Ubuntu>Ubuntu, with Linux 4.1.27-local"
#GRUB_HIDDEN_TIMEOUT=0
GRUB_HIDDEN_TIMEOUT_QUIET=false
GRUB_TIMEOUT=5
GRUB_DISTRIBUTOR=`lsb_release -i -s 2> /dev/null || echo Debian`
GRUB_CMDLINE_LINUX_DEFAULT=""
GRUB_CMDLINE_LINUX=""

# Uncomment to enable BadRAM filtering, modify to suit your needs
# This works with Linux (no patch required) and with any kernel that obtains
# the memory map information from GRUB (GNU Mach, kernel of FreeBSD ...)
#GRUB_BADRAM="0x01234567,0xfefefefe,0x89abcdef,0xefefefef"

# Uncomment to disable graphical terminal (grub-pc only)
#GRUB_TERMINAL=console

# The resolution used on graphical terminal
# note that you can use only modes which your graphic card supports via VBE
# you can see them in real GRUB with the command `vbeinfo'
#GRUB_GFXMODE=640x480

# Uncomment if you don't want GRUB to pass "root=UUID=xxx" parameter to Linux
#GRUB_DISABLE_LINUX_UUID=true

# Uncomment to disable generation of recovery mode menu entries
#GRUB_DISABLE_RECOVERY="true"

# Uncomment to get a beep at grub start
#GRUB_INIT_TUNE="480 440 1"

次の表は grub に施した修正の詳細です。万が一起動しない場合の緊急対応が出来る余地を追加し、起動時に表示されるメッセージを隠さず表示する修正を加えています。

grub2 boot loader を更新します。

$ sudo update-grub

特にエラーが無ければ、再起動します。

$ sudo /sbin/reboot

起動したことを確認する †

おそらく、起動中にメッセージが流れるようになった以外は何か特段の変化を感じる事は無いでしょう。GUI でログインするなり ssh でログインして変化を確認します。uname -a コマンドで Linux kernel version が変わったか見てみます。構築した Linux kernel に変わっているはずです。

$ uname -a
Linux lkdqwin01 4.1.27-local #1 SMP Fri Jul 29 02:04:48 JST 2016 x86_64 x86_64 x86_64 GNU/Linux

時間が掛かった割には、大きな変化が無く少々残念かもしれません。これで、Linux kernel のソースコードを好きに弄れる環境ができあがったのです。これからデバイス・ドライバを開発する中で起動中と起動した直後、「何も変わらない。あるいは実装中のドライバに関係したハードウエアの挙動以外は何も変わらない。」というのは確実な動作をするドライバを作っていく上で、つまらないけれど重要な動作確認の一歩です。

dmesg コマンドで起動時に流れたメッセージを改めて確認しましょう。今は何も変更していないので異常と思えるメッセージは有りません。下線をつけた部分が確かに今構築した Linux kernel であることを示しています。スクロールすると見えますが構築日時 Fri Jul 29 02:04:48 JST 2016 が出力されます。組み込み開発をしているとたまに「kernel を再構築したのに何も変わらないのはなぜ？」と悩むことがあります。この構築時刻を確かめ、確かに差し替えたことを確認します。

$ dmesg
[    0.000000] Initializing cgroup subsys cpuset
[    0.000000] Initializing cgroup subsys cpu
[    0.000000] Initializing cgroup subsys cpuacct
[    0.000000] Linux version 4.1.27-local (furuta@lkdqwin01) (gcc version 4.8.4 (Ubuntu 4.8.4-2ubuntu1~14.04) ) #1 SMP Fri Jul 29 02:04:48 JST 2016
[    0.000000] Command line: BOOT_IMAGE=/boot/vmlinuz-4.1.27-local root=UUID=7e6711c8-fd4c-4b35-a16a-c04d37e7778c ro
[    0.000000] KERNEL supported cpus:
[    0.000000]   Intel GenuineIntel
[    0.000000]   AMD AuthenticAMD
[    0.000000]   Centaur CentaurHauls
[    0.000000] tseg: 0000000000
[    0.000000] e820: BIOS-provided physical RAM map:
[    0.000000] BIOS-e820: [mem 0x0000000000000000-0x000000000009fbff] usable
[    0.000000] BIOS-e820: [mem 0x000000000009fc00-0x000000000009ffff] reserved
[    0.000000] BIOS-e820: [mem 0x00000000000f0000-0x00000000000fffff] reserved
[    0.000000] BIOS-e820: [mem 0x0000000000100000-0x000000003ffeffff] usable
[    0.000000] BIOS-e820: [mem 0x000000003fff0000-0x000000003fffffff] ACPI data
[    0.000000] BIOS-e820: [mem 0x00000000fec00000-0x00000000fec00fff] reserved
[    0.000000] BIOS-e820: [mem 0x00000000fee00000-0x00000000fee00fff] reserved
[    0.000000] BIOS-e820: [mem 0x00000000fffc0000-0x00000000ffffffff] reserved
... 以下省略dmesg 出力全て ...