yocto recipe : (2) 撰寫 bbappend

-

前言

xxx.bb 檔案是用來描述一個 recipe. 然而 xxx.bb 會因為 patch codes、新增 tasks、等等的因素修改. 這邊介紹如何使用 xxx.bbappend[1] 檔案. 以不修改 xxx.bb 的情況下擴充需求. 文章將以 patch codes 為例子, 並個別以 devtool 工具和手動的方式示範.

bbapend 簡介

.bbappend 是擴充 .bb 的方式. 藉由 .bbappend 來新增 tasks、patch code、新增/修改變數等等諸此之類的事. 其名稱必須跟所要修改的相同, 而版本號則依據需求寫.

舉例:
bb file 名稱: giflib_5.1.4.bb
bbappend 名稱: giflib_5.1.4.bbappend 或 giflib_%.bbappend.

%: 表示萬用字元

使用 .bbappend 的情況, 我個人認為有以下情況再使用
(1) 當 recipe 已存在 yocto 最基本的 layer, 不應隨便修改. 舉例: u-boot_2017.09.bb 存在於 yocto 的 meta layer
(2) 某些 layers 會共用此 recipe 的情況下. 舉例: meta-raspberrypi 與 meta-ti 分別各自使用自己的 xserver-xf86-config_0.1.bbappend 來對 yocto meta layer 的 xserver-xf86-config_0.1.bb 做擴充修改.

bbappend 範例

事前準備

用 giflib [4] 作為測試程式. 先下載 giflib-5.1.4.tar.bz2. 接著使用 bitbake-layer 建立 meta-custom layer, 再透過 recipetool 把產生的 giflib_5.1.4.bb 存放於此 layer. 

# 執行 oe-init-build-env 進行 yocto 編譯環境設定
[yijyun@localhost poky]$ . oe-init-build-env
# 建立 3rd-pkgs, 並把 giflib 放至此
[yijyun@localhost build]$ mkdir 3rd-pkgs; cd 3rd-pkgs/
[yijyun@localhost 3rd-pkgs]$ ls
giflib-5.1.4.tar.bz2
# 建立 meta-custom, 並加入yocto 環境
[yijyun@localhost build]$ bitbake-layers create-layer meta-custom
[yijyun@localhost build]$ bitbake-layers add-layer meta-custom
# 在底下建立 giflib  目錄
[yijyun@localhost build]$ cd meta-custom/recipes-example
yijyun@localhost recipes-example]$ rm -rf example/
[yijyun@localhost recipes-example]$ mkdir giflib
# 透過 recipetool 產生 bb
[yijyun@localhost recipes-example]$ cd ../../
[yijyun@localhost build]$ recipetool create -o meta-custom/recipes-example/giflib/giflib_5.1.4.bb  3rd-pkgs/giflib-5.1.4.tar.bz2

以 devtool 產生 .bbappend

新增 meta-custom-devtool-patch layer 來存放 devtool 之後產生的 bbappend. 

# 建立 meta-custom-devtool-patch layer
[yijyun@localhost build]$ bitbake-layers create-layer meta-custom-devtool-patch
[yijyun@localhost build]$ bitbake-layers add-layer meta-custom-devtool-patch
# 建立  giflib 目錄
[yijyun@localhost build]$ mkdir meta-custom-devtool-patch/recipes-example/giflib

使用 devtool 修改 source code 會產生 workspace layer, 並複製一份 giflib code 至 workspace/source
這邊針對 util/giffix.c 修改. 於 main 函數裡添加 printf("devtool hello !!\n"); 

# 藉由 devtool 來修改 code
[yijyun@localhost build]$ devtool modify giflib
NOTE: Source tree extracted to /media/disk1-1/Github/poky/build/workspace/sources/giflib
NOTE: Recipe giflib now set up to build from /media/disk1-1/Github/poky/build/workspace/sources/giflib

###### 修改 workspace/source/giflib/util/giffix.c  #########
int main(int argc, char **argv)
{
    printf("hello !!! (devtool)\n");      ///< 新增此行
    int i, j, NumFiles, ExtCode, Row, Col, Width, Height, ErrorCode,
    DarkestColor = 0, ColorIntens = 10000;

完畢之後, 至 source code 目錄下進行 git add 與 git commit. 最後在 devtool finish 即可產生 bbappend. 

# git add 與 commit
[yijyun@localhost giflib]$ git add util/giffix.c
[yijyun@localhost giflib]$ git commit -m "use devtool to create bbappend"
# 最後 devtool finish 表示完成修改, 把更新至於 meta-custom-devtool-patch
[yijyun@localhost sources]$ cd -
[yijyun@localhost sources]$ devtool finish giflib meta-custom-devtool-patch
# ls 查看相關檔案
yijyun@localhost build]$ ls meta-custom-devtool-patch/recipes-example/giflib/*
meta-custom-devtool-patch/recipes-example/giflib/giflib_%.bbappend

meta-custom-devtool-patch/recipes-example/giflib/giflib:
0001-use-devtool-to-create-bbappend.patch

手動撰寫 .bbapend

新增 meta-custom-manual-patch layer 來存放自己建立的 bbappend 和 patch.
因此在 recipes-example 底下建立 giflib 與 giflib/giflib. 其中 giflib/giflib 是 yocto 預設會搜尋的目錄
可以修改 FILEPATHS(常用於 .bb) or FILESEXTRAPATHS(常用於 .bbappend) 來符合自己的需求. 

# 新增 meta-custom-manual-patch layer 於環境
[yijyun@localhost build]$ bitbake-layers create-layer meta-custom-manual-patch
[yijyun@localhost build]$ bitbake-layers add-layer meta-custom-manual-patch
# 建立 giflib 相關目錄
[yijyun@localhost build]$ mkdir meta-custom-manual-patch/recipes-example/giflib/ meta-custom-manual-patch/recipes-example/giflib/giflib

這邊在 3rd-pkgs 手動複製一份 giflib, 並於 util/giffix.c 中添加 printf("hellow !! (manual)\n");.
接著在兩個 giflib 的目錄下, 使用 diff 產生出 patch. 把 patch 放置 meta-custom-manual-patch layer 

# 複製一份 giflib
[yijyun@localhost build] cd 3rd-pkgs
[yijyun@localhost 3rd-pkgs]$ cp -fa giflib-5.1.4 giflib-5.1.4_modify
# 修改過 code, 使用 diff 產生 patch
[yijyun@localhost 3rd-pkgs]$ diff -Naur giflib-5.1.4/util/giffix.c giflib-5.1.4_modify/util/giffix.c  > 00_giflib_util_giffix.patch
# 把 patch 放置 meta-custom-manual-patch
[yijyun@localhost 3rd-pkgs]$ cd ..
[yijyun@localhost build]$ mv 3rd-pkgs/00_giflib_util_giffix.patch meta-custom-manual-patch/recipes-example/giflib/giflib/

###### 修改 giflib-5.1.4_modify/util/giffix.c  ##########
int main(int argc, char **argv)
{
    printf("hellow !! (manual)\n");       ///< 新增此程式
    int i, j, NumFiles, ExtCode, Row, Col, Width, Height, ErrorCode,
    DarkestColor = 0, ColorIntens = 10000;

注意: 使用 diff 記得在 source code 的上一層, 不然 yocto 用 pacth 標示的檔案路徑時候會找不到對應檔案.
以下為 00_giflib_util_giffix.patch 裡的檔案路徑 

(ok)
--- giflib-5.1.4/util/giffix.c  2016-01-07 06:08:12.000000000 -0500
+++ giflib-5.1.4_modify/util/giffix.c   2018-04-28 08:13:52.209101817 -0400
<error>
--- giffix.c  2016-01-07 06:08:12.000000000 -0500
+++ giffix.c   2018-04-28 08:13:52.209101817 -0400

於 meta-custom-manual-patch 新增 giflib_5.1.4.bbappend. 填寫以下參數, 便完成以手動建立 bbappend. 

# 建立 giflib_5.1.4.bbappend
[yijyun@localhost build]$ vim meta-custom-manual-patch/recipes-example/giflib/giflib_5.1.4.bbappend

############# 以下為 giflib_5.1.4.bbappend 內容################
# 告知 bitbake 把 recipe 目錄給加入
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
# 告知 patch 名稱
SRC_URI_append = "\
    file://00_giflib_util_giffix.patch \
"

驗證

可於 tmp/work/i586-poky-linux/giflib/5.1.4-r0 查看是否有相關的 patch. 以及 於tmp/work/i586-poky-linux/giflib/5.1.4-r0/giflib-5.1.4/util/giffix.c 看 source code 是否有被修改 

# 檢查是否有 patch 檔案
[yijyun@localhost build]$ ls tmp/work/i586-poky-linux/giflib/5.1.4-r0/
00_giflib_util_giffix.patch  configure.sstate   deploy-rpms   giflib.spec
...
package          pkgdata         recipe-sysroot  sysroot-destdir

# 查看 source code 是否已被修改
[yijyun@localhost build]$ head -n 38 tmp/work/i586-poky-linux/giflib/5.1.4-r0/giflib-5.1.4/util/giffix.c  | tail -n 4
int main(int argc, char **argv)
{
 printf("hellow !! (manual)\n");
    int i, j, NumFiles, ExtCode, Row, Col, Width, Height, ErrorCode,

Reference

  1. Yocto Project Development Tasks Manual - using-bbappend-files
  2. Yocto Project Application Development and the Extensible Software Development Kit - 2. Using the Extensible SDK
  3. Yocto - devtool
  4. giflib

留言

張貼留言

這個網誌中的熱門文章

yocto recipe : (1) 撰寫 recipe

-
此篇文章介紹如何透過 yocto 的 utilities 來產生 recipe. 而完成的 recipe 又如何加入到 image. yocto 相關工具介紹 有三個適用於 layer 與 recipe 相關的 utilities. bitbake-layers: 負責 (1) 建立 layer. (2) 修改 bblayers.conf. (3) 查看 layer 底下的 recipes recipetool: 用於建立一個 recipe 和新增/修改 recipe. 這邊 recipe 在 yocto 即是 xx.bb 或 xx.bbappend 檔案 devtool: 定位在開發測試上. devtool 會建立一個獨立的 workspace layer. 讓開發者於此建立/修改 recipe 與 patch source code. 在不修改原有設定下與現有 layers 進行整合測試. 完畢之後可以再透過 devtool 新增或更新到 layer 裡 利用 utilities 撰寫 recipe 的時候. 要確保所屬的 layer 是存在於 bblayer.conf. 不然執行 bitbake [recipe basename] 會找不到相關的 recipe. yocto 事前準備 以 core-image-miniaml recipe 為例子. core-image-miniaml 會產生系統所需的 image 相關檔案. 接著利用 bitbake-layers 建立自己的 layer 於 build 目錄底下. 再透過 bitbake-layers 把 layer 加入到 bblayers.conf 設定檔. [ yijyun@localhost poky ] $ . oe-init-build-env [ yijyun@localhost build ] $ bitbake core-image-minimal [ yijyun@localhost build ] $ bitbake-layers create-layer meta-layer [ yijyun@localhost build ] $ bitbake-layers add-
閱讀完整內容

yocto recipe : (3) 使用 External Source 來編譯軟體

-
Yocto 有提供許多 fetch code 的方式[3], 大都是以抓取外網的方式. 雖然很齊全, 但是開發時候多少需要以本機上的 source code 作為來源進行編譯. 這邊就紀錄如何讓 yocto 直接抓取本機上的 source code 使用本機上的 source code 這邊介紹兩種方式. 使用硬碟上的 source code, 而不是透過 yocto fetch 去網路上抓取 (1) git fetcher: 基於 git fetcher, 僅修改 src_uri 參數, 就可以用本機上的 source code (2) external source: 基於 externalsrc class. 有兩種方式達成: (1) 於 recipe 直接新增 external source 變數 (2)於 local.conf 新增特定 recipe 的 external source 參數. 事前準備 於 build 目錄底下建立 3rd-pkgs. 把下載的 giflib 程式碼放置於此 [ yijyun@localhost build ] $ pwd /media/disk1-1/Github/poky/build [ yijyun@localhost build ] $ ls 3rd-pkgs/ giflib-5.1.4.tar.bz2 新增 meta-test 於 yocto. 並在此 meta-layer 底下新增 giflib 目錄. 存放之後的 bb files [ yijyun@localhost build ] $ bitbake-layers create-layer meta-test [ yijyun@localhost build ] $ bitbake-layers add-layer meta-test [ yijyun@localhost build ] $ mkdir meta-test/recipes-example/giflib git fetcher 使用 git fetcher 有兩個重點: src_uri 的 protocol 參數需要改為 file. S 的路徑要改為 S="
閱讀完整內容