Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 6.79 KB

steer-api-1.3.md

File metadata and controls

74 lines (60 loc) · 6.79 KB

steer-api 1.3 — что добавлено к 1.2

Ядро steer 2.1 говорит steer-api 1.3. Это прибавка к steer-api.md (1.0), steer-api-1.1.md и steer-api-1.2.md: плагин, написанный по 1.0–1.2, работает без изменений. Плагину, которому нужно новое, пишут compat.steer-api: "^1.3"; ядро отвечает steer version --json с "api":"1.3". Тест совместимости — sh tests/compat/run.sh --steer <каталог плагина> (заглушка ядра tests/compat/steer-2.1/host.py проверяет и пути в системе).

Появилось по нужде плагина box-connector (решение владельца: «steer-box-connector тоже плагин ядра, пакетов остаётся два»): podkop и forkop — апстрим, их код не меняется, а они ищут sing-box по известным путям — /usr/bin/sing-box, /etc/init.d/sing-box, /etc/config/sing-box. Код плагина лежит только в его каталоге; известные пути в системе ведёт менеджер плагинов.

Пути в системе: steer.links

"steer": {
  "links": [
    { "path": "/usr/bin/sing-box",     "target": "bin/sing-box" },
    { "path": "/etc/init.d/sing-box",  "target": "init/sing-box" },
    { "path": "/etc/config/sing-box",  "target": "defaults/sing-box", "mode": "conf" }
  ]
},
"permissions": ["fs:/usr/bin/sing-box", "fs:/etc/init.d/sing-box", "fs:/etc/config/sing-box"]
Поле Что
path абсолютный путь файла в системе. Пути ядра (/usr/lib/steer/…, /etc/steer/…, /usr/sbin/steer*, /etc/init.d/steer) — отказ
target файл внутри плагина ($defs/relpath)
mode link (умолчание) — символическая ссылка path → /usr/lib/steer/plugins/<id>/<target>; conf — копия target, если файла path нет

Как ведёт менеджер (steer src/pluginmgr/pminst.c, «steer.links»):

  • Права. Каждый path — под правом fs:<путь> (сам путь или каталог над ним). Путь — у одного плагина: второй плагин с тем же путём не ставится, отказ называет первый («путь /usr/bin/sing-box уже занят плагином …»).
  • Занятый путь — отказ до установки. Файл, который поставил не менеджер, менеджер не перезаписывает: отказ называет пакет-владельца по базе apk или opkg («box-connector не встаёт: /usr/bin/sing-box принадлежит пакету sing-box»). Чужой пакет — чужая настройка. Для conf стоящий файл остаётся как есть.
  • Когда. Ссылки ставятся после распаковки плагина и подмены каталога, до scripts.postinst: скрипт видит плагин на его путях. Обновление и откат меняют каталог плагина rename(2) под тем же именем, поэтому ссылка их переживает; пути, которых в новой версии нет, снимаются, при откате — возвращаются к прежней.
  • Пока стоит. Ссылки живут, пока плагин стоит, включён он или выключен: чужая программа ищет их всегда. steer plugin ensure <id> у стоящего плагина возвращает убранную ссылку.
  • Снятие. link снимается вместе с плагином (только своя ссылка). conf остаётся, как conffiles пакета, и уходит только с --purge; через sysupgrade её переносит keep.d/steer-plugins — менеджер дописывает туда пути conf сам, в keep их писать не нужно.
  • Ядро старше 1.3 поле не знает и поставило бы плагин без путей, поэтому плагин с steer.links пишет compat.steer-api: "^1.3" (s2p lint отказывает при диапазоне, в который входит 1.2).

Пакет, которого ждёт чужая программа: requires.system изнутри транзакции

Поле requires.system (manifest.md) было и в 1.0; в 1.3 у менеджера появился ключ для случая, когда скрипт системного пакета сам ставит плагин (post-install apk, postinst opkg):

steer plugin ensure <id> --pkg <имя пакета>

apk и opkg пишут свою базу в конце транзакции, после скриптов, — пакет, чей скрипт идёт, в базе ещё не виден, а звать apk/opkg изнутри их же транзакции нельзя (база заперта). --pkg говорит менеджеру: этот пакет ставится сейчас, считать его стоящим. Остальные пакеты requires.system, которых нет, в таком вызове не ставятся: отказ называет пакет и просит поставить его после.

Образец — box-connector: плагину нужен пакет steer-box-connector (без файлов, держит в базе пакетов имя sing-box, которое требуют podkop и forkop), а скрипт этого пакета ставит плагин. Почему имя держит отдельный пакет, а не steer-core, — migration-2.1.md, раздел 6.

Тест совместимости

tests/compat/steer-2.1/host.py (API 1.3) проверяет у каждой записи steer.links: абсолютный путь файла, один раз, не путь ядра, под правом fs:, mode из двух, цель — файл плагина; ставит ссылку в подставной корень и проверяет, что она ведёт в файл плагина, программа по ссылке в /usr/bin, /usr/sbin, /etc/init.d, /usr/libexec исполняемая, а в /usr/bin и /usr/sbin — запускается (version, код не 126/127).