Kbuild语法解析

最新推荐文章于 2024-06-15 21:40:11 发布

儒墨之争

最新推荐文章于 2024-06-15 21:40:11 发布

阅读量2.5k

点赞数

分类专栏： linux

linux 专栏收录该内容

19 篇文章 2 订阅

订阅专栏

https://blog.csdn.net/tangkegagalikaiwu/article/details/8508721

Kconfig note:

在hardware/intel/linux-2.6/arch/x86/configs/*****defconfig 里面出现的配置，如：CONFIG_X86_32=y ，

X86_32, 必须在某个Kconfig 里面与预先定义。

也就是说：Kconfig 是定义的地方，可以有个default值

***defconfig文件时重新为具体某个项目配置这些值的地方。

源头

在根目录下有个Kconfig文件，这就是一切故事的起源。

整个文件就没几行，打出来看一眼。

#
# For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt.
#
mainmenu "Linux/$ARCH $KERNELVERSION Kernel Configuration"

config SRCARCH
string
option env="SRCARCH"

source "arch/$SRCARCH/Kconfig"

第一行就是输出个内核版本号。

第二行应该是配置一个环境变量？不知道，以后再来看。

第三行很重要，这个是包含了一个arch目录下的Kconfig文件。

当你打开这个文件的时候，你就发现这是一切的开始。

我们运行make menuconfig, 你可以看到，这个文件就是make menuconfig中显示的东西。

一切都变得明朗起来，你是否有种太极生两仪，两仪生四象，四象生八卦的神奇感觉

剪不断，理还乱

kernel中这么多的模块之间的依赖关系，简直就是剪不断，理还乱。

幸好在Kconfig文件中，我们可以找到一点蛛丝马迹。

依赖 depends on

这个关键字表示了在某些配置选中后，本配置项才会显示。

在 driver/pci/Kconfig文件中有，

config PCI_MSI
   bool "Message Signaled Interrupts (MSI and MSI-X)"
   depends on PCI
   depends on ARCH_SUPPORTS_MSI

可以发现，要配置MSI必须要先支持PCI。恩这个道理咱都懂，连PCI都没有，哪里来的MSI啊。

反向依赖 select

这个关键字表示了当本配置项选中后，其他的配置项也需要选中。

在 arch/x86/Kconfig文件中有：

config HIGHMEM64G
   bool "64GB"
   depends on !M386 && !M486
   select X86_PAE
   ---help---
      Select this if you have a 32-bit processor and more than 4
      gigabytes of physical RAM.

其实这个我也不懂，看上去就是说要支持更多的物理内存，那么在x86的平台上，就要选中X86_PAE。

看上去是这么回事儿。

当我们编写完一个驱动后，我们要把它以模块形式编译或者直接编译进内核时，需要修改相关文件，其中最重要的便是kconfig ,makefile。主要是分析一下三者之间的关系，然后就其语法简要的谈一下。

当我们在内核源码目录下执行make （或者make menuconfig等命令）命令时，实际上是根据makefile 来进行编译的。我在mini2440开发板上编写了一个按键控制led灯的驱动。文件名为buttons_leds_zhao.c属于字符驱动。因此在/driver/char/目录下的makefile部分最后添加一行

obj-$(CONFIG_BUTTONS_LEDS_ZHAO) += buttons_leds_zhao.o

如下：

obj-y += mem.o random.o tty_io.o n_tty.o tty_ioctl.o tty_ldisc.o tty_buffer.o tty_port.o

obj-$(CONFIG_BFIN_JTAG_COMM) += bfin_jtag_comm.o

obj-$(CONFIG_CONSOLE_TRANSLATIONS) += consolemap.o consolemap_deftbl.o

obj-$(CONFIG_HW_CONSOLE) += vt.o defkeymap.o

obj-$(CONFIG_AUDIT) += tty_audit.o

obj-$(CONFIG_BUTTONS_LEDS_ZHAO) += buttons_leds_zhao.o

其中第一行obj-y 中的y表示编译进内核，而obj-$(CONFIG_LEGACY_PTYS) 中CONFIG_LEGACY_PTYS则表示一个变量，类似于我们C语言中的变量，用$( )来表示，它一般可以取三种值y ,m ,n.y表示编译进内核，而m则表示以模块的方式进行编译，n表示不编译进内核。obj-y += 等号后面的.o后缀文件则是由该目录下的对应名称的.c文件编译而来。而上面CONFIG_LEGACY_PTYS变量的取值则是通过.config文件来集中赋值的。.config部分内容如下

# Character devices
#
CONFIG_VT=y
CONFIG_CONSOLE_TRANSLATIONS=y
CONFIG_VT_CONSOLE=y
CONFIG_HW_CONSOLE=y
# CONFIG_VT_HW_CONSOLE_BINDING is not set
# CONFIG_DEVKMEM is not set
CONFIG_MINI2440_HELLO_MODULE=m
CONFIG_BUTTONS_LEDS_ZHAO=m
CONFIG_LEDS_MINI2440=m
CONFIG_MINI2440_BUTTONS=m
CONFIG_MINI2440_BUZZER=y
CONFIG_MINI2440_ADC=y
# CONFIG_SERIAL_NONSTANDARD is not set

从上面几行我们可以看到，在makefile里面的变量都是在.config中赋值的。当我们在源代码目录下输入make命令时，都是默认从.config中读入。

因此，在输入make之前，用ls -a 查看一下是否有该文件。对于只包含几个文件的工程来说，手动写.config和makefile并不是一件很难的事情，但如果是一个包含有几百个文件的项目来说，则是一件比较困难的事情。可以用autoconf来自动生成.config，automake来制作makefile。看起来问题是解决的，但实际上，这种做法缺乏一定的灵活性，不能实现按需定制的要求。如果要添加或删掉某个驱动，将要在.config文件中找到相应的项进行修改。非常的不方便。因此，便出现了kconfig。

当我们在内核源码目录下输入make menuconfig时，出现如下内容：

.config - Linux Kernel v2.6.32.2 Configuration
────────────────────────────────────────────────────────────────────────────────────────────────

┌──────────Linux Kernel Configuration────────────────────┐
│  Arrow keys navigate the menu.  <Enter> selects submenus --->.  Highlighted letters are          │
│  hotkeys.  Pressing <Y> includes, <N> excludes, <M> modularizes features.  Press <Esc>       │
│  to exit, <?> for Help, </> for Search.  Legend: [*] built-in  [ ] excluded  <M> module              │
│  < > module capable                                                                                     │
│ ┌──────────────────────────────────────────────┐ │
│ │             General setup  --->                                                               ││
│ │         [*] Enable loadable module support  --->                                       ││
│ │         -*- Enable the block layer  --->                                                    ││
│ │             System Type  --->                                                                 ││
│ │             Bus support  --->                                                                  ││
│ │             Kernel Features  --->                                                             ││
│ │             Boot options  --->                                                                 ││
│ │             CPU Power Management  --->                                                  ││
│ │             Floating point emulation  --->                                                  ││
│ │             Userspace binary formats  --->                                                │ │
│ │             Power management options  --->                                              │ │
│ │         [*] Networking support  --->                                                        │ │
│ │             Device Drivers  --->                                                              │ │
│ │             File systems  --->                                                                 │ │
│ └─────────┴(+)────────────────────────────────┘│
├──────────────────────────────────────────────┤
│                              <Select>    < Exit >    < Help >                                  │
└──────────────────────────────────────────────┘

它是通过读取在内核源码目录下的Kconfig文件来配置的。在/drivers/char/下的目录kconfig部分内容如下：

config DEVKMEM
        bool "/dev/kmem virtual device support"
        default y
        help
          Say Y here if you want to support the /dev/kmem device. The
          /dev/kmem device is rarely used, but can be used for certain
          kind of kernel debugging operations.
          When in doubt, say "N".

config MINI2440_HELLO_MODULE
        tristate "Mini2440 module sample"
        depends on MACH_MINI2440
        default m if MACH_MINI2440
        help
          Mini2440 module sample.

config BUTTONS_LEDS_ZHAO
        tristate "Mini2440 button  and leds sample"
        depends on MACH_MINI2440
        default m if MACH_MINI2440
        help
          Mini2440  button and leds  module sample.

其具体语法格式说明如下：

config关键字是一个新的配置选项的入口其后的选项MINI2440_HELLO_MODULE 省略了CONFIG。完整的表示为CONFIG_MINI2440_HELLO_MODULE,也即是当我们将该选项设置成y时，它将自动的将 .config的CONFIG_MINI2440_HELLO_MODULE=m改写成CONFIG_MINI2440_HELLO_MODULE=y。紧接着的是菜单的属性最主要的有2种tristate ,boolean 。tristate表示三态：编译进内核（y)，编译成模块(m)，不编译(n)。boolean 主要有两种y或n。depend则表示依赖项。default缺省的编译选项 m表示默认该文件表示以模块方式编译。后面的help是帮助信息，当我们选中help菜单时就可以看见，它不是必需的。随着操作系统升级，编译选项达到几千个。对于一般人来说，要搞清每一个选项是很困难的，一般很多选项都是默认的。

总的来说，三者之间的关系如下：当我们在内核源码目录下输入make menuconfig时，在出现的菜单界面中选择一项时，它会自动更新.config相应项的值。如果我们没有选择，则会在.config问下插入一行注释。类似于# CONFIG_SERIAL_NONSTANDARD is not set，当我们输入make时，根据makefile文件来编译，makefile文件中的变量值则由.config来进行赋值操作。仅仅只在kconfig中添加选项，只会在菜单界面中显示，即使此时选择y或m，也不会编译文件。还需要在makefile文件中按照规定添加相应行才能进行编译。简单图解如下：

kconfig------->.config---------->makefile

make menuconfig/.config/Kconfig解析

分类： linux内核编译2011-10-09 15:16 1184人阅读评论(2) 收藏举报

在对linux进行编译，常用的命令是make menuconfig，使用图形界面来对整个系统进行裁剪。当然，除了这条指令，还包括很多配置命令，比如make defconfig, make oldconfig等。这里主要就make menuconfig的执行过程进行解析。

一．准备工作

包括(交叉)编译环境的建立，linux源码的下载与解压等。

二．初步介绍

跟make menuconfig这个命令相关的文件，包括三类，包括.config，Kconfig，Makefile。为什么不说三个，而说三类呢？因为Kconfig和Makefile是配合使用的，在很多的子目录都存在，而.config只存在于根目录中。这三个文件的作用分别是：

Kconfig：定义了配置项

.config：对配置项进行赋值

Makefile：建立配置项的生成法则

看到这里，可能有人就头疼了，到底什么是配置项，什么是生成法则。这里要求具有理解Makefile的能力，如果不懂的话，可以去找Makefile的相关资料。

如果使用举例的话，比较容易理解。比如，我编写了mytest.c的文件，这里不关心mytest.c的内容。如果想把mytest.c编译到内核中，需要按照以下的步骤来完成。

1) 将test.c放到任何一个目录中，这个目录只要求已存在Kconfig和Makefile中，比如源码根目录/arch/arm/目录中。

2) 在这个目录的Kconfig中添加

config MY_TEST

bool “My Test”

3) 在Makefile中添加

obj-$(CONFIG_MY_TEST) += mytest.o

4) 在.config中可以添加 CONFIG_MY_TEST = y来选中。

或者在执行make menuconfig时，找到显示名为My Test的选项，使用空格选中。

总而言之，就是如果需要向系统内核中添加一个功能，那么首先定义一个配置项对应于这个功能，添加到特定的Kconfig文件中。然后在Makefile里，定义这个配置项需要编译哪些文件。最后就可以通过make menuconfig或者直接修改.config来使能这个配置项。

.config作为全局配置项的使能信息，存在于根目录中。里面内容基本上都是以下形式：

CONFIG_XX_XX=y/n/m/0xFFFFFF/32/”XXXXXXX”

其实，.config就是将执行make menuconfig后，对配置项的修改保存到一个文件中而已。如果没有.config时，make menuconfig会按照默认值来显示。

三．配置的必要性

在下载linux内核的时候，应该注意到了linux内核一般都很大，大概有70-80MB。这么大的内核对于PC来说，可能不是很大，但是对于嵌入式来说，那可就很大了。因为内核很大一部分都是常驻内存的，所以对于内存和硬盘来说，都是一种浪费。而且，内核中很大一部分也不需要被编译，比如arch目录是表示不同平台的信息，由于我们烧写的内核只用于一种平台，那么其他的目录完全是不需要烧写到内核里的。这样就要求，一部分文件需要编译，一部分文件不需要编译，这样就有了内核裁剪(配置)的需要了。而对于不同的配置方式，可能使用的手段是不同的，但是目的都是一样的，就是配置内核中需要编译的文件。通过编译后，内核的大小基本上是2.5MB。

四．Kconfig语法

1. 基本构成

基本构成包括五种，menu/endmenu，menuconfig，config，choice/endchoice，source。下面就对每种详细介绍：

(1) menu/endmenu

menu的作用，可以理解成一个目录，menu可以把其中一部分配置项包含到一个menu中，这样有利于配置的分类显示。menu与endmenu是一组指令，必须同时出现。menu和endmenu中包含的部分就是子目录中的配置项。

比如，在init/Kconfig中24行(可能不同)显示为：

menu "General setup"

这样，就会生成一个目录，特征就是右侧会出现一个箭头，如图1中第一行。当点击确认键时，会进入这个菜单项，如图2。

图1

图2

(2) menuconfig

menuconfig有点类似menu，但区别就在于menu后面多了一个config，这个menu是可以配置的，如图2中的第二行，前面比menu类型多了一个方框，通过空格可以修改这个配置项的选中状态。而且从格式上来看，也是有区别的。格式如init/Kconfig中1131行：

menuconfig MODULES

bool "Enable loadable module support"config

if MODULES

endif

也就是说，配置项是位于if和endif中。其中的部分就是MODULES子目录显示的内容。如果选中了MODULE，那么if和endif中的内容可以显示。如果没有定义，就只能进入一个空目录。

(3) config

config是构成Kconfig的最基本单元，其中定义了配置项的详细信息。定义的格式参考arch/arm/Kconfig中的第8行。

config ARM

bool

default y

select xxxxxxxxxx

help

???????????

可知，config需要定义名称，与menuconfig相同。这个名称不但用于裁剪内核中，还用于配置项之间的相互依赖关系中。

config的类型有5种，分别是bool(y/n)，tristate(y/m/n)，string(字符串)，hex(十六进制)，integer(整数)。其中，需要特别介绍一下bool和tristate，bool只能表示选中和不选，而tristate还可以配置成模块(m)，特别对于驱动程序的开发非常有用。

其他语法如下：

1) prompt：提示，显示在make menuconfig中的名称，一般省略。下面两种写法相同。

a. bool “Networking Support”

b. bool

prompt “Networking Support”

2) default：默认值

一个配置项可以有多个默认值，但是只有第一个被定义的值是有效的。

3) depends on/requires：依赖关系

如果依赖的配置项没有选中，那么就当前项也无法选中。

4) select：反向依赖

如果当前项选中，那么也选中select后的选项。

5) range：范围，用于hex和integer

range A B表示当前值不小于A，不大于B

6) comment：注释

(4) choice/endchoice

choice的作用，多选一，有点像MFC中的Radio控件。参考arch/arm/Kconfig第205行。

choice

prompt "ARM system type"

default ARCH_VERSATILE

???????

config ARCH_S3C2410

bool "Samsung S3C2410, S3C2412, S3C2413, S3C2440, S3C2442, S3C2443"

select GENERIC_GPIO

select ARCH_HAS_CPUFREQ

select HAVE_CLK

???????

endchoice

显示的结果如图3，进入这一项后，显示结果如图4.

图3

图4

可见，choice有点类似于menu，是在子窗口里选择，但是不同的是子窗口中只能选择一项。在prompt后会显示当前选择项的名称。

(5) source

source只是将另外一个Kconfig文件直接复制到当前位置而已。但它的作用也是明显的，可以将这个系统贯穿在一起。从开始位置arch/arm/Kconfig，来将整个系统都作为配置型。

五．配置分析

当我们进入了linux源码的根目录时，输入make menuconfig。假设，此时根目录已经存在了.config，如果不存在，会自动生成。这时，在命令行显示如图5.

图5

显然，在执行make menuconfig时，会自动调用scripts/Kconfig/mconf arch/arm/Kconfig开始系统的配置，那么arch/arm/Kconfig就是配置的起点。这个文件会通过source指令来调用其他目录下的Kconfig文件，从而完成整体配置。这样，arch/arm/Kconfig就可以理解成main函数，而source指令就有点类似于include。可以按照上面的语法，来分析Kconfig文件。

本文参考友善之臂的MICRO2440用户手册

毛毛同学今天学习了驱动程序模块的安装与卸载，在这个过程中毛毛发现，内核的目录中有许多的Kconfig、Makefile文件，但是毛毛不知道为什么需要这些文件，这些文件又是用来做什么的。下面我们就和陶毛毛同学一起来学习下这些文件的作用是什么。
首先我们来学习什么Makefile，什么是Kconfig ，什么是.config
Ｍakefile：一个文本形式的文件，其中包含一些规则告诉make编译哪些文件以及怎样编译这些文件。

Kconfig：一个文本形式的文件，其中主要作用是在内核配置时候，作为配置选项。

.config：文件是在进行内核配置的时候，经过配置后生成的内核编译参考文件。

Kconfig

1.先了解一下Kconfig的语法：
一个典型的内核配置菜单如下：
menu "Network device support"
config NETDEVICES
        bool "Enable Net Devices"
        depends on NET
        default y
       help
               This is help desciption。
...
endmenu
包含在menu/endmenu中的内容会成为Network device support的子菜单。每一个子菜单项都是由config来定义的。congfig下方的那些bool、depends on、default、help等为config的属性，用于定义该菜单项的类型、依赖项、默认值、帮助信息等。
2. 补充说明一下类型定义部分：
每个config菜单项都要有类型定义: bool布尔类型、 tristate三态(内建、模块、移除)、string字符串、 hex十六进制、 integer整型。
例如：
config HELLO_MODULE
bool "hello test module"
bool 类型的只能选中或不选中，显示为[ ]; tristate类型的菜单项多了编译成内核模块的选项，显示为< > , 假如选择编译成内核模块，则会在.config中生成一个 CONFIG_HELLO_MODULE=m的配置，假如选择内建，就是直接编译成内核影响，就会在.config中生成一个 CONFIG_HELLO_MODULE=y的配置. hex十六进制类型显示为（）。

3. 目录层次迭代
在Kconfig中有类似语句：source "drivers/usb/Kconfig"
用来包含（或嵌套）新的Kconfig文件，这样便可以使各个目录管理各自的配置内容，使不必把那些配置都写在同一个文件里，方便修改和管理。

----------------------------------------------------------------------------------------------

Makefile
2.6内核的Makefile分为5个组成部分：
       1. 最顶层的Makefile
       2. 内核的.config配置文件
       3.   在arch/$(ARCH) 目录下的体系结构相关的Makefile
       4. 在s目录下的 Makefile.* 文件，是一些Makefile的通用规则
       5. 各级目录下的大概约500个kbuild Makefile文件

顶层的Makefile文件读取 .config文件的内容，并总体上负责build内核和模块。Arch Makefile则提供补充体系结构相关的信息。 s目录下的Makefile文件包含了所有用来根据kbuild Makefile 构建内核所需的定义和规则。

Kbuild Makefile
对于Makefiles的不同组成部分，有一些不同的语法规则。针对的对象也不同，对于大部分内核模块或设备驱动的开发者和使用者来说，最常接触到的就是各层目录下基于kbuild架构的kbuild Makefile文件。Kbuild Makefile核心内容主要包括：
1.目标定义
目标定义就是用来定义哪些内容要做为模块编译，哪些要编译链接进内核。如：

obj-y += foo.o

表示要由foo.c或者foo.s文件编译得到foo.o并链接进内核，而obj-m则表示该文件要作为模块编译。除了y，m以外的obj-x形式的目标都不会被编译。而更常见的做法是根据.config文件的CONFIG_ 变量来决定文件的编译方式（该变量如何起作用见文末另一篇文章的链接），如：
obj-$(CONFIG_EXT2) += ext2.o

除了obj-形式的目标以外，还有lib-y library库，hostprogs-y 主机程序等目标，但是基本都应用在特定的目录和场合下。

例子说明：

下面我们以实例来说明这几个文件的作用

Step1：编辑配置文件Kconfig，加入驱动选项，使之在make menuconfig 的时候出现
打开 linux-2.6.32.2/drivers/char/Kconfig 文件，添加如图所示：

保存退出，这时在linux-2.6.32.2 目录位置运行一下make menuconfig 就可以在Device
Drivers Character devices 菜单中看到刚才所添加的选项了，按下空格键将会选择为<M>，
此意为要把该选项编译为模块方式；再按下空格会变为<*>，意为要把该选项编译到内核中，
在此我们选择<M>，如图：

Step2：通过上一步，我们虽然可以在配置内核的时候进行选择，但实际上此时执行编译内核还是不能把mini2440_hello_module.c 编译进去的，还需要在Makefile 中把内核配置选项和真正的源代码联系起来，打开linux-2.6.32.2/drivers/char/Makefile，如图添加并保存退出：