OpenWrt开发 之扩展软件包

OpenWrt是一个比较完善的嵌入式Linux开发平台，在无线路由器应用上已有100多个软件包。人们可以在其基础上增加软件包，以扩大其应用范围。OpenWrt在增加软件方面使用极其方便，按照OpenWrt的约定就可以很简单完成。
加入的软件包可以是网上可下载的开源软件或自行开发的软件。为加入软件包需要在package目录下创建一个目录，以包含软件包的各种信息和与OpenWrt建立联系的文件。然后创建一个Makefile与OpenWrt建立联系，Makefile需要遵循OpenWrt的约定。另外可以创建一个patchs目录保存patch文件，对下载的源代码进行适量修改。

OpenWrt的软件包基本都被部署在<OP root-dir>/packages/*，以samba作为例子。我们可以了解到在OP下其目录结构如下：

 /samba/        |--/files/        |         |--- /samba.init        |         |--- /smb.conf        |         |--- /smbd.conf        |--/patches/        |        |---100-samba.patch        |        |---102-codepages.patch        |---Makefile

file/中存放的是软件默认配置、初始化文件等(可选项)

ptches/存放用于修复bug，或者升级的补丁文件.(可选项)

Makcefile 定义了软件在OP中的所有规则包括：源码的获取，如何编译等重要信息.是最为重要的

src/ 约定俗成用于存放软件包源码。一般源码获取方式存在本地时此文件夹才存在，对于源码获取方式来自网络服务器则不需要此文件夹，示例中由于samba源码将从网络获取则没有 src 文件夹
所以当我们需要添加自己的软件包时，必须遵循这些规则部署到<OP root-dir>/packages/*。然后的重点就是关于软件包内Makefile的书写规则。它与GNU的makefile相比增加了很多OpenWrt自己的规则。下面则着重介绍TA。

1.包的引入

OpenWrt软件包规则中使用三个makefile的子文件，分别为：

     include $(TOPDIR)/rules.mk      #一般在Makefile的开头     include $(INCLUDE_DIR)/kernel.mk    # 对于软件包为内核时不可缺少     include $(INCLUDE_DIR)/package.mk  # 一般在软件包的基本信息完成后再引入

软件包加入OpenWrt的方式就由这些makefile所决定

2.编写软件包的基本信息

这些软件包的信息均以PKG_开头，其意思和作用如下：

PKG_NAME     表示软件包名称，将在menuconfig和ipkg可以看到。PKG_VERSION      表示软件版本号。PKG_RELEASE      表示Makefile的版本号PKG_SOURCE       表示源代码的文件名。PKG_SOURCE_URL     表示源代码的下载网站位置。@SF表示在sourceforge网站，@GNU表示在GNU网站，还有@GNOME、@KERNEL。获取方式可以为：git、svn、cvs、hg、bzr等。下载规则定义在:$(INCLUDE_DIR)/download.mk和$(SCRIPT_DIR)/download.pl中PKG_MD5SUM     表示源代码文件的效验码。用于核对软件包是否正确下载。PKG_CAT     表示源代码文件的解压方法。包括zcat, bzcat, unzip等。PKG_BUILD_DIR     表示软件包编译目录。它的父目录为$(BUILD_DIR)。如果不指定，默认为$(BUILD_DIR)/$( PKG_NAME)$( PKG_VERSION)。PKG_INSTALL     Setting it to ‘1’ will call the package’s original  ‘make install’  with prefix set to ‘PKG_INSTALL_DIR’PKG_INSTALL_DIR    Where ‘make install’ copies the compiled filesPKG_FIXUP    关于autotools的选项。软件源码中的makefile使用makefile工具自动生成 

此外还有一些有关源代码的定义

PKG_SOURCE_SUBDIRPKG_SOURCE_PROTOPKG_SOURCE_MIRRORPKG_MIRROR_MD5SUMPKG_SOURCE_VERSION

3.定义包的编译操作

用户程序和内核模块的定义不一样。用户态软件包使用Package，内核模块使用KernelPackage。

3.1用户程序编译包定义

用户程序的编译包以Package/开头,然后接着软件名，在Package定义中的软件名可以与软件包名不一样，而且可以多个定义

3.1.1基本信息:

Package/$(PKG_NAME)SECTION    表示包的类型，预留。CATEGORY    表示分类，在menuconfig的菜单下将可以找到。TITLE    用于软件包的简短描述DESCRIPTION    用于软件包的详细描述，已放弃使用。如果使用DESCRIPTION将会提示“error DESCRIPTION:= is obsolete, use Package/PKG_NAME/description”。URL    表示软件包的下载网址。MAINTAINER    表示维护者，选项。DEPENDS    表示与其他软件的依赖。即如编译或安装需要其他软件时需要说明。如果存在多个依赖，则每个依赖需用空格分开。依赖前使用+号表示默认显示，即对象没有选中时也会显示，使用@则默认为不显示，即当依赖对象选中后才显示。

Tips:

在用户态的软件包中没有内核模块的AUTOLOAD参数。如果软件需要在boot时自动运行，则需要在/etc/init.d增加相应的脚本文件。脚本文件需要START参数，说明在boot时的优先级，如果在boot过程启动后在关闭，则需要进一步设置STOP参数。如果STOP参数存在，其值必须大于START。脚本文件需要start()和stop()两个函数，start()是执行程序，stop()是关闭程序。关闭程序一般需要执行killall命令。由/etc/rc.d/S10boot知道，装载内核模块的优先级为10，需要使用自己设计的内核模块的程序其START的值必须大于10. 同样由/etc/rc.d/S40network知道，使用网络通信的程序其START的值必须大于40。

3.1.2操作配置:

• Package/$(PKG_NAME)/conffiles

包安装的配置文件，一行一个。如果文件结尾使用/，则表示为目录。用于备份配置文件说明，在sysupgrade命令执行时将会用到

• Package/$(PKG_NAME)/description

软件包的详细描述，取代前面提到的DESCRIPTION详细描述。

• Build/Prepare

编译准备方法，对于网上下载的软件包不需要再描述。对于非网上下载或自行开发的软件包必须说明编译准备方法。一般的准备方法为：

define Build/Prepare        mkdir -p $(PKG_BUILD_DIR)        $(CP) ./src/* $(PKG_BUILD_DIR)/endef

(按OpenWrt的习惯，一般把自己设计的程序全部放在src目录下)

• Build/Configure

在Automake中需要进行./configure，所以本配置方法主要针对需要配置的软件包而设计，一般自行开发的软件包可以不在这里说明。需要使用本定义的情况，可参考dropbear。

• Build/Compile

编译方法，没有特别说明的可以不予以定义。如果不定义将使用默认的编译方法Build/Compile/Default

自行开发的软件包可以考虑使用下面的定义。

define Build/Compile        $(MAKE) -C $(PKG_BUILD_DIR) \                $(TARGET_CONFIGURE_OPTS) CFLAGS="$(TARGET_CFLAGS) -I$(LINUX_DIR)/include"endef

• Package/$(PKG_NAME)/install

软件包的安装方法，包括一系列拷贝编译好的文件到指定位置。调用时会带一个参数，就是嵌入系统的镜像文件系统目录，因此$(1)表示嵌入系统的镜像目录。一般可以采用下面的方法：

define Package/$(PKG_NAME)/install        $(INSTALL_DIR) $(1)/usr/bin        $(INSTALL_BIN) $(PKG_BUILD_DIR)/ $(PKG_NAME) $(1)/usr/bin/endef

INSTALL_DIR、INSTALL_BIN在 $(TOPDIR)/rules.mk 文件定义，所以本Makefile必须导入 $(TOPDIR)/rules.mk 文件。

INSTALL_DIR :=install -d -m0755 意思创建所属用户可读写即执行，其他用户可读可执行的目录。

INSTALL_BIN:=install -m0755意思编译好的文件到镜像文件目录。

类似的
PKG_BUILD_DIR、PKG_INSTALL_DIR 等都在 $(TOPDIR)/rules.mk 、 $(INCLUDE_DIR)/package.mk中可以找到定义.

如果用户态软件在boot时要自动运行，则需要在安装方法说明中增加自动运行的脚本文件安装和配置文件安装方法。

例如：

define Package/mountd/install        $(INSTALL_DIR) $(1)/sbin/ $(1)/etc/config/ $(1)/etc/init.d/        $(INSTALL_BIN) $(PKG_BUILD_DIR)/mountd $(1)/sbin/         $(INSTALL_DATA) ./files/mountd.config $(1)/etc/config/mountd         $(INSTALL_BIN) ./files/mountd.init $(1)/etc/init.d/mountdendef

安装文件放在files子目录下，不要与源代码文件目录src混在一起，以提高可读性,使用清晰的文件扩展名，更方便安装识别文件。

• Package/$(PKG_NAME)/preinst

软件包安装前处理方法，使用脚本语言，因此定义的第一行需要下面的格式

#!/bin/sh

调用时带入的参数为嵌入式系统的镜像目录。

• Package/$(PKG_NAME)/postinst

软件包安装后处理方法，使用脚本语言。

• Package/$(PKG_NAME)/prerm

软件包删除前处理方法，使用脚本语言

• Package/$(PKG_NAME)/postrm

软件包删除后处理方法，使用脚本语言

3.2内核模块包定义

Linux分为内核态和用户态。开发者开发的内核部分可以直接加入Linux的Kernel程序，也可以生成内核模块以便需要时装入内核。OpenWrt一般希望开发者生成内核模块，在Linux启动后自动装载或手工使用insmod命令装载。

OpenWrt的内核模块定义信息使用KernelPackage开头，有别于普通软件包的Package，其他与一般软件包基本相同。

include $(INCLUDE_DIR)/kernel.mk    # 定义内核模块必须引入此规则        ....define KernelPackage/$(PKG_NAME)    # 内核模块使用 KernelPackage/$(PKG_NAME)定义软件包define Package/$(PKG_NAME)        # 一般软件包使用 Package/$(PKG_NAME)定义软件包

• SUBMENU

由于在$$(INCLUDE)/kernel.mk **已经对内核模块定义了 **CATEGORY 为 kernel modules ，所以内核模块在menuconfig中的主菜单为kernel modules ，我们只需要定义下一级子菜单SUBMENU，于是在子菜单下才可以看到以kmod-$(PKG_NAME) 条目。

• DEFAULT

表示直接编入内核或产生内核模块的默认操作。y表示直接编入内核，m表示产生内核模块

• AUTOLOAD

表示自动装入内核，一般表示方法为：

AUTOLOAD:=$(call AutoLoad, $(PRIORITY),$(AUTOLOAD_MODS))  第一个参数 $(PRIORITY)为优先级，01表示最高优先级，99为最低优先级。有关自动装载可以在 /etc/modules.d 目录下看到第二个参数 $(AUTOLOAD_MODS) 为模块名，每个模块名以空格符分隔。即可同时装载多个内核模块。

注:在开发过程最好不要使用自动装载，经过严格调试后再使用，可以减轻调试的工作量

4.使用定义

完成前面定义后，必须使用eval函数实现各种定义。如此，软件包才会出现在相应的make menuconfig 配置菜单中。其格式为：

对于一般软件包

$(eval $(call Package,$(PKG_NAME)))

或对于内核模块

$(eval $(call KernelPackage,$(PKG_NAME)))

如果一个软件包有多个程序，例如：一个应用程序有自己的内核模块，上面使用的PKG_NAME需要灵活变通。eval函数可能设计多个。也可以当成多个软件包处理。

5.编译

在make menuconfig 编译配置中选择软件包的编译方式（编入固件<*>，还是独立的IPK包 < M > ），然后执行 make。

如果只想单独编译一个软件包，而不是编译整个OP系统.则可在 make menuconfig 中选择为 < M > ,并可执行下面命令。编译出来的IPK包将被放在/bin//package/内

make /package/<PKG_DIR+PKG_NAME>/compile V=s

---