Lời nói đầu

Trong loạt bài này, mình sẽ giới thiệu Devtool, một công cụ mạnh mẽ dành cho developer bên cạnh Bitbake. Như các bạn biết, Yocto Project là một hệ thống phân tán, nơi mã nguồn phần mềm được tải từ nhiều nguồn như GitHub, sau đó đưa vào thư mục trung gian để biên dịch.

Tuy nhiên, khi làm việc với Yocto, việc chỉnh sửa source code dễ gây lỗi biên dịch, và tạo patch thủ công rất phức tạp, tốn thời gian. Đây là lúc Devtool được sinh ra, giúp developer chỉnh sửa, build, và kiểm tra code nhanh chóng mà không cần quá nhiều thao tác thủ công như với Bitbake.

Devtool làm được những gì ?

Devtool chủ yếu được sử dụng với ba mục đích chính: add, modify và upgrade .

Khi sử dụng devtool add, một recipe sẽ được tự động tạo ra.
Devtool modify recipe hiện tại sẽ được sử dụng để xác định source code cần lấy và cách vá nó.
Devtool upgrade giúp cập nhật phiên bản recipe hiện có

Các lệnh cơ bản của Devtool

Trước hết chúng ta thiết lập môi trường môi trường của mình. Sau khi thiết lập thì có thể kiểm tra các lệnh Devtool bằng cách dùng lệnh devtool -h . Đây sẽ là cách chúng ta khám phá các lệnh chính của Devtool

**~/poky**
source oe-init-build-env
devtool -h

**Output**
NOTE: Starting bitbake server...
usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q]
               [--color COLOR] [-h]
               <subcommand> ...

OpenEmbedded development tool

options:
  --basepath BASEPATH   Base directory of SDK / build directory
  --bbpath BBPATH       Explicitly specify the BBPATH, rather than getting it
                        from the metadata
  -d, --debug           Enable debug output
  -q, --quiet           Print only errors
  --color COLOR         Colorize output (where COLOR is auto, always, never)
  -h, --help            show this help message and exit

subcommands:
  Beginning work on a recipe:
    add                   Add a new recipe
    modify                Modify the source for an existing recipe
    upgrade               Upgrade an existing recipe
  Getting information:
    status                Show workspace status
    search                Search available recipes
    latest-version        Report the latest version of an existing recipe
    check-upgrade-status  Report upgradability for multiple (or all) recipes
  Working on a recipe in the workspace:
    build                 Build a recipe
    rename                Rename a recipe file in the workspace
    edit-recipe           Edit a recipe file
    find-recipe           Find a recipe file
    configure-help        Get help on configure script options
    update-recipe         Apply changes from external source tree to recipe
    reset                 Remove a recipe from your workspace
    finish                Finish working on a recipe in your workspace
  Testing changes on target:
    deploy-target         Deploy recipe output files to live target machine
    undeploy-target       Undeploy recipe output files in live target machine
    build-image           Build image including workspace recipe packages
  Advanced:
    create-workspace      Set up workspace in an alternative location
    menuconfig            Alter build-time configuration for a recipe
    extract               Extract the source for an existing recipe
    sync                  Synchronize the source tree for an existing recipe
    import                Import exported tar archive into workspace
    export                Export workspace into a tar archive
Use devtool <subcommand> --help to get help on a specific command

Như mình đã đề cập phía trên Devtool có thể thực hiện ba nhiệm vụ chính: add, modify và upgrade. Ngoài ra, Devtool còn có các lệnh phụ khác như build, rename ,reset, finish và deploy. Nó cũng cho phép deploy recipe thông qua SSH lên thiết bị target để kiểm tra, và có thể undeploy lại.

Bạn có thể sử dụng option --help đối với mỗi chức năng của devtool để biết thêm về syntax ví dụ như sau:

**~/poky/build**
devtool add --help

**Output**
NOTE: Starting bitbake server...
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev]
                   [--version VERSION] [--no-git]
                   [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH]
                   [--binary] [--also-native] [--src-subdir SUBDIR]
                   [--mirrors] [--provides PROVIDES]
                   [recipename] [srctree] [fetchuri]

Adds a new recipe to the workspace to build a specified source tree. Can
optionally fetch a remote URI and unpack it to create the source tree.

arguments:
  recipename            Name for new recipe to add (just name - no version,
                        path or extension). If not specified, will attempt to
                        auto-detect it.
  srctree               Path to external source tree. If not specified, a
                        subdirectory of
                        /home/peeta/poky/build/workspace/sources will be used.
  fetchuri              Fetch the specified URI and extract it to create the
                        source tree

options:
  -h, --help            show this help message and exit
  --same-dir, -s        Build in same directory as source
  --no-same-dir         Force build in a separate build directory
  --fetch URI, -f URI   Fetch the specified URI and extract it to create the
                        source tree (deprecated - pass as positional argument
                        instead)
  --npm-dev             For npm, also fetch devDependencies
  --version VERSION, -V VERSION
                        Version to use within recipe (PV)
  --no-git, -g          If fetching source, do not set up source tree as a git
                        repository
  --srcrev SRCREV, -S SRCREV
                        Source revision to fetch if fetching from an SCM such
                        as git (default latest)
  --autorev, -a         When fetching from a git repository, set SRCREV in the
                        recipe to a floating revision instead of fixed
  --srcbranch SRCBRANCH, -B SRCBRANCH
                        Branch in source repository if fetching from an SCM
                        such as git (default master)
  --binary, -b          Treat the source tree as something that should be
                        installed verbatim (no compilation, same directory
                        structure). Useful with binary packages e.g. RPMs.
  --also-native         Also add native variant (i.e. support building recipe
                        for the build host as well as the target machine)
  --src-subdir SUBDIR   Specify subdirectory within source tree to use
  --mirrors             Enable PREMIRRORS and MIRRORS for source tree fetching
                        (disable by default).
  --provides PROVIDES, -p PROVIDES
                        Specify an alias for the item provided by the recipe.
                        E.g. virtual/libgl

Cây thư mục Workspace

Trong Yocto Project, Workspace là một không gian làm việc riêng biệt khi sử dụng devtool. Nó cho phép developer tùy chỉnh, kiểm tra module hoặc package mà không ảnh hưởng đến hệ thống chính. Workspace hỗ trợ modify nhanh, biên dịch riêng lẻ, quản lý phiên bản, và custome image hiệu quả.

attic Một thư mục được tạo ra nếu devtool cho rằng cần phải giữ lại bất kỳ nội dung nào khi bạn chạy lệnh "devtool reset".
Ví dụ: Nếu bạn chạy lệnh "devtool add", thay đổi recipe, sau đó chạy "devtool reset", devtool sẽ nhận thấy tệp đã bị thay đổi và sẽ di chuyển nó vào thư mục attic nếu bạn vẫn muốn giữ recipe.
README Tệp cung cấp thông tin về những gì có trong lớp workspace và cách quản lý nó.
.devtool_md5 Tệp chứa mã kiểm tra (checksum) được devtool sử dụng để xác minh tính toàn vẹn của các tệp.
appends Một thư mục chứa các tệp *.bbappend, dùng để tạo bản vá (patch) cho các mã nguồn bên ngoài.
conf Thư mục cấu hình chứa tệp layer.conf để thiết lập layer workspace.
recipes Một thư mục chứa các recipe (công thức). Mỗi thư mục con trong đây được tạo cho mỗi recipe được thêm vào. Devtool sẽ đặt file recipe.bb vào trong từng thư mục con tương ứng.
sources Thư mục chứa bản sao mã nguồn được sử dụng khi xây dựng recipe. Đây là thư mục mặc định chứa cây mã nguồn nếu bạn không cung cấp đường dẫn riêng. Mỗi tập mã nguồn sẽ có một thư mục con tương ứng với recipe của nó.

Quy trình làm việc của devtool

Source Bắt đầu là repo từ đó chúng ta lấy source code có thể từ Github. Sử dụng lệnh devtool addđể tải source code và tự động tạo ra recipe cơ bản. Ví dụ như lệnh: devtool add <recipe-name> <url-source-code>

Workspace Sau khi source code được tải, devtool sẽ được đặt nó vào một workspace và tạo recipe tương ứng. Công cụ sẽ nhận diện hệ thống build như Makefile , Cmake và cấu hình recipe tương ứng

Build Sau khi recipe được tạo, tiến hành build recipe bằng lệnh devtool build <recipe-name>, tương tự như cách sử dụng bitbake để build các recipe

Deploy Nếu quá trình build thành công, thì sẽ triển khai file bin lên thiết bị lên thiết bị target (có thể là raspberry pi, beagle Bone Black, NXP) bằng lệnh devtool deploy-target <recipe-name>

Undeploy Sau khi hoàn thành quá trình kiểm tra, có thể gỡ file bin ra khỏi thiết bị target bằng lệnh devtool undeploy-target <recipe-name>

Finish Khi mọi thứ hoạt động như mong đợi, hoàn tất recipe bằng cách chạy lệnh devtool finish, lệnh này sẽ di chuyển recipe từ workspace vào hệ thống layer của Yocto