OpenWrt开发:16---构建自己的系统软件

前言：

• 构建自己的系统软件，原理请参考OpenWrt软件编译构建系统文章：https://blog.csdn.net/qq_41453285/article/details/102545605
• 下面我们自己以一个自己设计的Hello程序为例，一步一步地构建出自己的软件

一、程序实现的功能

• 我们实现一个在路由器启动后访问指定网站的功能，这样就可以统计路由器的启动次数。网站地址可以在配置文件中进行自定义配置，这个网址通过UCI编程接口读取配置文件来实现。访问指定网站功能通过命令行工具wget来实现。但如果其他人也使用wget来访问服务器，这样就不能区分是路由器行为还是其他应用软件的行为，因此我们修改了代理字符串来作为我们的自定义字符串（使用wget的--user-agent参数，参数如何使用见wget文章），这样就可以和默认的访问行为区分开来
• 为了防止某些小区在断电并自动启动后，均立即访问服务器，对服务器产生瞬间流量冲击，因此路由器启动后产生一个随机延迟时间，然后再访问服务器。这个时间可以通过配置文件设置，假如设置为100秒，则访问服务器时间就为1～100秒的随机值

二、软件目录结构

• 通常新增一 个模块的主要步骤如下：
  • 在OPenWrt源码的package目录下增加一个目录（例如hello）
  • 在hello目录下添加src目录和files目录
  • src目录存放模块源码和源码编译Makefile
  • files目录存放模块的配置文件及启动脚本等
  • 在hello顶级目录增加Makefile。此Makefile中包含编译脚本和安装脚本
• 我们软件的目录为名为hello，放置在OpenWrt源码的package目录下：
  • files目录包含配置文件和初始化脚本
  • files目录下的hello.conf为配置文件，在安装后放在/etc/config/目录下的 hello 文件中
  • files目录下hello.init用于控制进程启动的初始化脚本
  • Makefile包含编译及安装指令，控制着代码在 OpenWrt 环境下的编译和生成安装包
  • src目录保存C语言源代码和一个hello.c文件的Makefile
  • src目录下的hello.c为上面的程序C语言代码
  • src目录下Makefile为hello.c的Makefile

三、src目录设计

• 这个目录下存放着程序的源代码hello.c与hello.c的Makefile文件

Makefile文件

• 这个Makefile与hello目录下的Makefile不一样，顶级目录下的Makefile是用于全局编译时使用的，这个Makefile只是用来生成软件使用的

hello.c代码设计

• 例如：某公司想了解已售出路由器的使用情况，如路由器的启动次数。我们在每次启 动时将访问指定服务器。Agent 为第一次启动时生成的随机数和指定的代理固定字符串组 合。这样简单修改示例代码的配置文件即可实现。大多数服务器已有记录访问日志功能， 只需统计服务器的访问日志即可实现路由器启动次数的统计

#include 
#include 
#include 
#include 
#include 

//根据选项来访问服务器。
struct Hello
{
    char agent[50]; //代理字符串
    char url[256];  //访问的url，此处设置为我们在Ubuntu中使用python命令开启的一个HTTPS服务器网址
    int delay;      //启动后延迟多长时间访问
};

int getValue(struct uci_context *ctx, char *key, char*value, int n)
{
    char strKey[100];
    struct uci_ptr ptr;
    snprintf(strKey, sizeof(strKey), "hello.globe.%s",key); //将hello.globe.agent/url/delay 写入strKey中
    //uci_lookup_ptr：分割字符串并查找
	//参数1：UCI上下文环境对象 2：查找的结果保存到ptr中 3：待查找的字符串 4：是否允许扩展查找
	if (uci_lookup_ptr(ctx, &ptr, strKey, true) == UCI_OK) //从/etc/config/hello配置文件中找（备注：默认从/etc/config目录下读取）
    {
        printf("%s\n", ptr.o->v.string);
        strncpy(value, ptr.o->v.string, n-1); //将查找的字符串保存到value中
    }
    return 0;
}

int read_conf( struct Hello *hello)
{
    struct uci_context *ctx = uci_alloc_context(); //分配UCI上下文环境对象
    if (!ctx)
    {
        fprintf(stderr, "No memory\n");
        return 1;
    }
    getValue(ctx, "agent", hello->agent, sizeof(hello->agent)); //将配置文件中agent的值读取到hello->agent中
    getValue(ctx, "url", hello->url, sizeof(hello->url)); //将配置文件中url的值读取到hello->url中
    char delay[20];
    getValue(ctx, "delay", delay, sizeof(delay)); //将配置文件中delay的值读取到hello->delay中
    hello->delay = atoi(delay); //字符串转换为整型
    uci_free_context(ctx); //释放UCI上下文环境对象
    return 0;
}

struct Hello hello;
int main(int argc, char* argv[])
{
    /*
    char agent[50] = "openwrt";
    char url[100] = "http://192.168.43.20:8080";
    */
    
    //从/etc/config/hello配置文件中读取参数，并将读取到的内容设置到struct Hello中
    read_conf(&hello);
    
	//打印一下从配置文件中获取的数据
	printf("agent=%s\n", hello.agent);
    printf("url=%s\n", hello.url);
    printf("delay=%d\n", hello.delay);
    
	char cmd[512] = {0};
    snprintf(cmd, sizeof(cmd), "wget --user-agent=%s %s",hello.agent, hello.url); //将wget命令设置到cmd字符串中
    //system("wget --user-agent=openwrt http://192.168.43.20:8080");
    printf("cmd=%s\n", cmd);

    //srand(time(NULL));
    int delay_time = rand() % hello.delay; //延迟时间
    printf("delay_time=%d\n", delay_time);
    sleep(delay_time);

    system(cmd);  //执行wge命令
    return 0;
}

四、顶级Makefile设计

• 此Makefile为hello顶级目录下的Makefile，通过此Makefile来控制编译不是src目录下的

include $(TOPDIR)/rules.mk
include $(INCLUDE_DIR)/kernel.mk


PKG_NAME:=hello
PKG_RELEASE:=1.0

PKG_BUILD_DIR := $(BUILD_DIR)/$(PKG_NAME)
PKG_CONFIG_DEPENDS :=

include $(INCLUDE_DIR)/package.mk


define Package/$(PKG_NAME)
	SECTION:=net
	CATEGORY:=Network
	TITLE:=Hello utility
	DEPENDS:=+libuci
	URL:=https://blog.csdn.net/qq_41453285/article/details/102545618
	MAINTAINER:[email protected]
endef

define Package/$(PKG_NAME)/description
	This is Route Hello World OpenWrt.
endef

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


define Build/Configure
endef

define Build/Compile
	$(MAKE) -C $(PKG_BUILD_DIR) \
		$(TARGET_CONFIGURE_OPTS) \
		CFLAGS="$(TARGET_CFLAGS)" \
		CPPFLAGS="$(TARGET_CPPFLAGS)"\ 
		LDFLAGS="$(TARGET_LDFLAGS)"
endef

define Package/$(PKG_NAME)/install
	$(INSTALL_DIR) $(1)/etc/config
	$(INSTALL_CONF) ./files/hello.conf $(1)/etc/config/hello
	
	$(INSTALL_DIR) $(1)/etc/init.d
	$(INSTALL_BIN) ./files/hello.init $(1)/etc/init.d/hello
	
	$(INSTALL_DIR) $(1)/usr/sbin
	$(INSTALL_BIN) $(PKG_BUILD_DIR)/hello $(1)/usr/sbin/hello
endef

$(eval $(call BuildPackage,$(PKG_NAME)))

Makefile解析

• 首先包含rules.mk文件，接着将软件包名称定义为“hello”，并设置版本编号为“1.0”，这样编译出来的软件包将包含字符串“hello_1.0”

• 在软件包定义中，我们设置软件包分类为“Network”。我们在make menuconfig时，可以在Network分类中找到它

• 我们设置依赖变量 DEPENDS 为“+libuci”，因为我们的C语言代码里面调用了UCI的接口函数，否则我们在编译时会遇到“libuci.so”找不到类似的错误信息。依赖是指哪些包必须在这个软件包之前编译和安装。注意，是使用+包名称，“+libuci”表示如果选择本软件包时，libuci软件包也会被自动选择

• “Build/Prepare”定义了如何准备编译本软件包，这里创建了编译目录，然后将代码复制到编译目录下，编译目录位于build_dir/target-i386_pentium4_musl-1.1.16/hello目录下

• 下面图片是编译之后的显示结果（我把他提到前面来做个演示，演示一下Build/Prepare选项所做的操作）

• “Package/hello/install”定义了安装本软件包时会发生哪些操作，$(1)表示传入的第一个参数，在安装时，通常为根目录。共有3个文件需要安装，Makefile自动创建了3个目录（如果已存在就不创建），然后将3个文件分别复制到各自的目录下：
  • 首先将配置文件“hello.conf”复制到配置目录“/etc/config”下，并重命名为hello
  • 接着将启动脚本“hello.init”复制到启动目录“/etc/init.d”下，并重命名为hello
  • 最后将编译生成的可执行程序hello复制到 “/usr/sbin”目录下

• 最后调用BuildPackage，将软件包的名称作为参数传递给BuildPackage

五、配置文件设计（hello.conf）

配置文件分析：

config globals 'globe'
	option agent 'openwrt'
	option url 'http://192.168.43.20:8080'
	option delay '10'

• 在hello.c源码中，程序会读取hello配置文件中globe配置节中的agent、url、delay选项的值，这些值用于我们程序的使用

选项含义如下

• agent：wget命令执行时的代理字符串
• url：软件启动时，访问的URL
• delay：软件启动延迟机制所设置的时间

• 配置文件的格式见文章（https://blog.csdn.net/qq_41453285/article/details/102527800）中的UCI的统一配置原理
• 在Makefile中，hello.conf配置文件会被自动复制到/etc/config目录下，并重命名为hello

六、软件启动脚本设计（hello.init）

• 关于软件启动机制与脚本设计，见下篇文章详细介绍：https://blog.csdn.net/qq_41453285/article/details/102545624
• 在Makefile中，hello.init启动脚本会被自动复制到/etc/init.d目录下，并重命名为hello

脚本分析：

• START、STOP变量：脚本的执行顺序通过START和STOP变量来定义，此处我们分别设置为15和85
• start()、stop()函数：决定软件如何启动和停止服务，在start()函数中我们调用了“hello”命令，因此在系统启动时我们的hello软件就会执行，从而达到开机自启动的效果
• custom()函数：最后是增加扩展命令 custom，仅仅输出扩展命令信息，并没有实际功能
• 在这个例子中，这个命令在启动时取代start函数而执行boot函数，如果boot函数没有被重新定义，将执行rc.common中预定义的 boot函数，boot函数再次调用start函数。 如果你不带参数运行命令，将会自动调用help函数输出帮助信息

#!/bin/sh /etc/rc.common
# hello script

START=15
STOP=85

start() {
    echo "start HelloRoute!"
    hello
}

stop() {
    echo "stop HelloRoute!"
    #hello -t
}

EXTRA_COMMANDS="custom"
EXTRA_HELP="        custom Help for the custom command"

custom() {
    echo "custom command"
}

• 备注：如果使用opkg命令安装软件时脚本一般均有执行权限，如果是自己手动新增脚本，不要忘记确认脚本是否有执行权限（通过运行chmod +x /etc/init.d/hello命令来增加执行权限）

备注：

• 我们的配置文件编辑时要采用Linux系统的格式编辑，否则在openwrt中运行这个脚本时会因为换行符的原因导致脚本无法正常执行

七、单独编译软件

• OpenWrt支持编译单个软件包，这样可以非常方便地编译单个软件包来定位问题

步骤

• 第一步：将我们的hello目录全部复制到Ubuntu的openwrt源码的package目录下

• 第二步：回到在openwrt源码顶级目录下，输入make menuconfig进行配置，进入Network模块，然后选择hello（输入M将hello设置为M，M代表模块类型编译，“*”代表系统性编译）然后保存退出，保存之后会更新.config配置文件，如果不进行这一步，下面编译时会出错

• 第三步：输入以下命令进行编译：

make package/hello/compile V=s

• 之后就可以看到生成安装文件为bin/packages/i386_pentium4/base目录下找到对应的.ipk安装包

• 以后想要更改程序的功能时，删除.ipk再次编译即可

八、在平台编译中编译软件

• 如果我们要加入平台编译过程中，可以在make menuconfig时选择hello模块
• 再在隐藏的配置文件“.config”中会增加一项“CONFIG_PACKAGE_hello=y”，这样就可以在编译整个系统时自动编译生成我们的软件模块
• 如果遇到编译错误，使用make V=s即可看到详细的编译过程和错误信息

九、在openwrt中安装.ipk文件并使用

第一步

• 将.ipk文件传从Ubuntu中发送到OpenWrt系统中

第二步

• 开启Ubuntu，在Ubuntu中开启一个HTTPS服务器，监听端口为8080，等待openwrt路由器连接hello程序的连接

第三步

• 使用openwrt的opkg命令安装.ipk文件，安装程序的时候，配置文件都启动了，因此在第二张图中可以看到我们的Ubuntu服务器接收到了openwrt的连接

• 安装完之后可以看到hello软件在/usr/sbin/hello目录下（Makefile脚本设计的），我们可以直接在命令行输入hello运行这个程序

• 配置文件在/etc/config目录下，开机自启动的程序在/etc/init.d目录下（Makefile脚本设计的）

• 在/etc.rc.d目录下也创建了我们的开机自启动脚本的软链接

• 这样之后我们的软件就可以开机自启动了
• 备注：如果想要取消我们的软件在开机自启动，输入（/etc/init.d/hello  disable）即可，同时在/etc/rc.d下的软链接也会消失

第四步（可选）

• 如果想要卸载软件，输入下面的命令即可

• 此时再去输入hello命令发现软件已经不存在了，并且配置文件与启动脚本都不存在了

备注：

• 本次设计，在openwrt关机重启之后，脚本却没有执行，解决了很久还没有解决，待续......

十、构建中出现的问题

问题一

• 如果编译时出错，请检查如下地方：
  • ①hello顶级目录下的Makefile是否增加了libuci库
  • ②hello/src目录下的Makefile中gcc命令是否加上了-luci
  • ③检查Makefile脚本缩进是否正确

问题二

• 如果程序运行时遇到libc找不到的错误，是因为编译时的Makefile编写不正确，使用了宿主机的编译指令导致使用宿主机的libc.so.6动态链接库

问题三

• 出现下面的问题是因为我们的hello.init文件中换行符不是属于Linux格式的换行符，是换行符引发的问题

• 解决办法是使用notepad编辑hello.init配置文件，改用Linux格式

问题四

• 开机之后脚本不执行，查看/etc/init.d/hello脚本是否有可执行权限，没有可执行权限，使用下面方法增加

chmod +x /etc/init.d/hello