Instructions

Для образа потребуется не менее 90Gb памяти. Процесс сборки займёт более 2 часов (зависит от выделенных ресурсов).

Для выполнения следующих шагов необходим Docker и Docker compose v2!

Необходимо клонировать репозиторий. Это можно выполнить следующей командой:

git clone https://github.com/moevm/os_profiling.git

Yocto

Для удобного взаимодействия с проектом был реализован скрипт entrypoint.sh, далее рассмотрим его функционал.

Функционал скрипта:

./entrypoint.sh

После выполнения команды будет выведена информационная справка по использованию скрипта, возможные аргументы и т.д.

Usage: entrypoint [ env | build-env ]
            --no-perf -- disables installation of the perf
            --no-cache -- disables docker cache using

          *required stage build-env*
          [ sh | shell ]
          [ by | build-yocto ]
              --only-poky -- only clones poky repo
              --no-layers -- build yocto image without layers and dependencies
              --tracing <tool> -- enables tracing of the build with one of the tools (perf, ftrace, strace)
              --conf-file <path> -- config file to use (works only for --no-layers)

          *required cloned poky*
          [ p | patch ] <list_of_patches>
              -r, --reverse -- disable choosen patches
              -l, --patches-list -- print available patches

          *required built yocto*
          [ sy | start-yocto ]

          [ cd | clean-docker ]
          [ cb | clean-build ]
              -o, --orig -- also cleans original poky dir
          [ deps | install-deps ]
          [ check ]

Проверка установки всех необходимых зависимостей:
```
./entrypoint.sh check
```
После выполнения команды произойдёт проверка всех необходимых зависимостей, для каждой из которых будет выведен статус, а далее общий результат. Пример:
```
SUCCESS: docker is installed.
SUCCESS: docker compose (v2.25.0) is installed.

Verification completed successfully!
```

Образ среды для проекта:

./entrypoint.sh env

После выполнения команды начнётся сборка образа с помощью Docker. При необходимости можно отключить утилиту perf, для этого к предыдущей команде необходимо добавить флаг --no-perf. Как это примерно должно выглядеть:

[+] Building (12/12) FINISHED                                                                  docker:default
 => [yocto_project internal] load build definition from Dockerfile                                     
 => => transferring dockerfile: 2.24kB                                                                 
 => [yocto_project internal] load metadata for docker.io/library/ubuntu:20.04                          
 => [yocto_project internal] load .dockerignore                                                        
...
 => [yocto_project] exporting to image      
 => => exporting layers
 => => writing image sha256:...
 => => naming to docker.io/library/yocto-image

Командная строка контейнера:
```
./entrypoint.sh shell
```
После выполнения команды будет запущен контейнер и открыт терминал. Должно получиться следующее:
```
[+] Running 1/1
 ✔ Container yocto_project  Started 
To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

yocto_user@7212e2e38268:~/project$ 
...
```

Сборка образа Yocto:

./entrypoint.sh by

После выполнения команды начнётся сборка образа Yocto внутри контейнера, когда произойдет автоматическое закрытие контейнера (с кодом 0) -- всё будет установлено. При необходимости можно только склонировать poky, для этого к предыдущей команде необходимо добавить флаг --only-poky.

Пример удачной сборки:

[+] Running 1/1
Attaching to yocto-container
...
yocto-container  | You can also run generated qemu images with a command like 'runqemu qemux86-64'.
yocto-container  | 
yocto-container  | Other commonly useful commands are:
yocto-container  |  - 'devtool' and 'recipetool' handle common recipe tasks
yocto-container  |  - 'bitbake-layers' handles common layer tasks
yocto-container  |  - 'oe-pkgdata-util' handles common target package tasks
yocto-container  | 
yocto-container  | Build Configuration:
yocto-container  | BB_VERSION           = "2.7.3"
yocto-container  | BUILD_SYS            = "x86_64-linux"
yocto-container  | NATIVELSBSTRING      = "universal"
yocto-container  | TARGET_SYS           = "x86_64-poky-linux"
yocto-container  | MACHINE              = "qemux86-64"
yocto-container  | DISTRO               = "poky"
yocto-container  | DISTRO_VERSION       = "4.3+snapshot-1fb353995c7fbfaa9f1614ed52a4a6aa04ccae5a"
yocto-container  | TUNE_FEATURES        = "m64 core2"
yocto-container  | TARGET_FPU           = ""
yocto-container  | meta                 
yocto-container  | meta-poky            
yocto-container  | meta-yocto-bsp       = "my-upstream:1fb353995c7fbfaa9f1614ed52a4a6aa04ccae5a"
yocto-container  | 
yocto-container  | Initialising tasks...
yocto-container  | done.
yocto-container  | NOTE: Executing Tasks
...
yocto-container  | NOTE: Tasks Summary: Attempted 4099 tasks of which 4099 didn't need to be rerun and all succeeded.
yocto-container exited with code 0

Для запуска сборки с инструментом трассировки нужно использовать опцию --tracing <tool>. Конфигурация трассировки опциями происходит через переменную среды TRACING_OPTIONS, установка её значения:

export TRACING_OPTIONS="your_options"

При выборе инструмента ftrace стоит учитывать, что используется трассировщик и файлы ядра, поэтому необходимо, при возникновении ошибок доступа, раскомментировать команды в файле:

sudo mount -t debugfs none /sys/kernel/debug
sudo chmod -R 777 /sys/kernel/debug/tracing

Важно, что при изменении прав доступа к этим файлам в Docker-контейнере, они также изменяться на хосте!

Запуск образа Yocto:
```
./entrypoint.sh sy
```
После выполнения будет открыта авторизация в системе Yocto, которая будет выглядеть так:
```
...
Poky (Yocto Project Reference Distro) 4.3+snapshot-1fb353995c7fbfaa9f1614ed52a4a6aa04ccae5a qemux86-64 /dev/ttyS0

qemux86-64 login: 
```
Все действия далее описаны в разделе "Работа с Yocto".
Для применения патчей реализован команды, примеры использования:

Применить патч buildstats_netstats.patch.
```
./entrypoint.sh patch buildstats_netstats.patch
```
Можно применить сразу несколько патчей, тогда просто передаём их список.
```
./entrypoint.sh patch buildstats_netstats.patch poky_dir.patch
```
Откатить патч buildstats_netstats.patch.
```
./entrypoint.sh patch buildstats_netstats.patch -r
```
Аналогично можно откатить список патчей.

Получить список доступных патчей.
```
./entrypoint.sh patch -l
```

Работа с Yocto

Для авторизации в системе необходимо указать login, его значение root. Поздравляю, вы получили доступ к системе. Выход из системы осуществляется 2 способами:

Ctrl + A, + X
Ctrl + A, + C, + type quit

Анализ сборки

Для анализа был разработан набор скриптов.

Для их корректной работы необходимо:

Предустановленный пакет python3-venv
```
sudo apt install python3-venv
```
Установить зависимости (скрипт полностью автоматизирован только для систем Linux):
```
./entrypoint.sh deps
```

После выполнения команды произойдёт создание виртуального окружения venv в директории проекта (os_profiling), его активация и установка всех необходимых зависимостей.

Если у вас уже есть виртуальное окружение, активация и установка зависимостей:

source <path-to-venv>/bin/activate
pip3 install -r <project-path>/requirements.txt

Деактивация окружения:

deactivate

Experiments

Checking mirrors patch usage (fast instruction)

Index file for sstate-cache

Основной патч cachefiles.patch: добавляет проверку на индекс файл на сервере, и если он есть, то использует информацию из него для оптимизации поиска на удаленных кэш-серверах
- Если нет index файла, то используется прошлая схема
На кэш-сервере должен быть index файл. Местоположение: $path_to_sstate_cache_dir/index.txt

Индекс файл можно получить двумя способами:

Через патч compose_indexfile.patch, который после завершения сборки создаст index файл в папке с sstate-cache
Через отдельный скрипт, который можно использовать уже на имеющемся кэше (работает на python!)

import os
import sys

if __name__ == "__main__":
    if len(sys.argv) < 2:
        print(f"USAGE: {sys.argv[0]} </path/to/sstate_dir>")
        exit(1)
    directory = sys.argv[1]
    output_file = os.path.join(directory, 'index.txt')
    with open(output_file, 'w') as f:
        for root, dirs, files in os.walk(directory):
            for file in files:
                file_path = os.path.join(root, file)
                relative_path = os.path.relpath(file_path, directory)
                f.write(f"{relative_path}\n")

Mirrors availability

Патч async_filter_with_time.patch: добавляет проверку на доступность зеркал с кэшом по протоколу tcp
- Должно работать из коробки

Net limitation

Патчи:
- add_net_buildstats.patch добавляет сбор статистики по использованию сети. Сохраняет результаты в файлы reduced_proc_net.log, net_pressure.log и current_max_pressure.log
- add_net_limit.patch добавляет достижение лимита сети при выборе задачи из очереди (если достигнут лимит, то выбирается build задача вместо fetch)
- Должно работать из коробки

Task reweighing

Основной патч add_task_children_to_weight.patch: увеличивает приоритет задачам, которые имеют большее количество потомков в графе зависимостей
- Для работы необходим файл task-children.txt!
Вспомогательный файл task-children.txt содержит информацию о потомках для каждой задачи. Как его получить:
- Выгрузить из yocto граф зависимостей: bitbake -g $your_image_recipe
- Запустить утилиту для анализа: python3 main.py -g task_children -d $path_to_generated_task_depends.dot
- Файл task-children.txt будет лежать в dep_graph/text-files/task-children.txt
- Скопировать полученный файл в папку poky/build
- После этого патч при запуске сборки начнёт работать

Патч проверки доступности серверов SSTATE_MIRRORS

Проблематика

Проблема заключается в том, что если указаны нерабочие сервера в SSTATE_MIRRORS, то эти нерабочие сервера опрашиваются на наличие кэша, что повышает процесс Checking sstate mirror object availability

Решение

Решение заключается в том, что на стадии парсинга файла local.conf производится асинхронный опрос адресов из переменной SSTATE_MIRRORS и те, которые доступны, перезаписываются в переменную SSTATE_MIRRORS, о чем выводится Warning. Патч, реализующий этот функционал - async_with_time_and_domains.patch.

Применить патч

Чтобы применить этот патч, необходимо перенести его в корень репозитория poky и выполнить команду git apply async_filter_with_time.patch

Проверка

Нужно применить патч.
В local.conf нужно указать hash сервер
В local.conf нужно указать в переменную SSTATE_MIRRORS рабочие сервера и нерабочие сервера
Провести сборку с помощью bitbake <target>
Во время сборки нужно смотреть на логи, выведется сообщение "Time from the start to end of checking sstate availability =="

Name		Name	Last commit message	Last commit date
Latest commit History 981 Commits
src		src
tests		tests
wiki		wiki
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
README_en.md		README_en.md
entrypoint.sh		entrypoint.sh
requirements.txt		requirements.txt
run_experiments.sh		run_experiments.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Instructions

Yocto

Работа с Yocto

Анализ сборки

Experiments

Checking mirrors patch usage (fast instruction)

Index file for sstate-cache

Mirrors availability

Net limitation

Task reweighing

Патч проверки доступности серверов SSTATE_MIRRORS

Проблематика

Решение

Применить патч

Проверка

About

Uh oh!

Releases

Packages

Contributors 8

Uh oh!

Languages

License

moevm/yocto_profiling

Folders and files

Latest commit

History

Repository files navigation

Instructions

Yocto

Работа с Yocto

Анализ сборки

Experiments

Checking mirrors patch usage (fast instruction)

Index file for sstate-cache

Mirrors availability

Net limitation

Task reweighing

Патч проверки доступности серверов SSTATE_MIRRORS

Проблематика

Решение

Применить патч

Проверка

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 8

Uh oh!

Languages

Packages