Rukověť baliče RPM - XII (Makra, úvod)

4. 8. 2005 | David Nečas | Návody | 6237×

Jak makra expandují, odkud se berou a jak se testuje jejich existence.

Makra I

S makry jsme se setkali již v úvodní pitvě spec souboru, jistě ale tušíte, že to s nimi nebude tak jednoduché, jako jsem to napsal.

Jak se expandují

Při expansi makra je %název_makra (resp. %{název_makra}) nahrazeno tělem makra. Expanse probíhá rekursivně, dokud je co expandovat nebo nějakým zacyklením nepřekročíme maximální hloubku expanse.

Zacyklit se lze snadno, neboť při definici se tělo makra neexpanduje, až při použití. V následující ukázce tedy echo vypíše lobster-888, nikoli lobster-123:

%define ver 123
%define pkgdir %{name}-%{ver}
…
%define ver 888
echo %pkgdir

Co se stane, když se má expandovat neexistující makro? V takovém případě není výsledek expanse prázdný, jak jsme snad zvyklí z některých makrojazyků, ani to nevyvolá chybu, jak jsme možná zvyklí z jiných, ale expanse prostě neproběhne a zůstane nám někde %makro. To může být záludné.

Skončí-li rpmbuild s chybou podobnou této

Bad exit status from /var/tmp/rpm-tmp.11899 (%build)

a o něco výše vidíme

/var/tmp/rpm-tmp.11899: line 83: fg: no job control

tak jsme právě narazili na neexistující makro, které vypadalo kupříkladu (makro %make definuje PLD, ale jinde definováno nebývá)

%make

Jelikož se makro neexpandovalo, dostal %make k provedení shell, který si je vyložil jako příkaz k přenesení úlohy make na popředí, který se mu stěží mohlo podařit vykonat, když byl neinteraktivní. V tomto případě jsme ale měli spíš štěstí, neboť zůstane-li omylem neexpandované makro vprostřed řádku, budeme ho asi hledat déle.

Ještě záludnější je ovšem expanse, kde ji nečekáme. Že máme procenta zdvojovat a spouštět date +%%S, a ne date +%S (z kterého by nám rpmbuild udělal date +%SOURCE), to už víme z úvodu. Ale co může být špatně na řádku

#%configure

kde jsme dočasně zakomentovali %configure? Jen malý detail: komentáře se interpretují až po expansi maker. Pravidlo, že nejprve se plně expandují všechna makra, a teprve pak se zpracují komentáře, je jednoduché a jednoznačné i v případě, kdy expansí maker vznikají další komentáře, ale intuitivní zrovna není. Z %configure jsme tak zakomentovali jen první řádek, načež jsme se samozřejmě podivili, co se to děje.

Chceme-li důkladně zakomentovat makro, jež může být víceřádkové, uděláme to například jedním z těchto způsobů:

#configure
#%%configure
#% configure

jež všechny fungují – na rozdíl od výše uvedeného.

Kde se berou

Několik maker zná rpm sám od sebe. Kupříkladu stará známá %setup a %patch jsou do něj zadrátovány. Má to různé obskurní vedlejší efekty, například jsou rozeznávány jen na začátku řádku a lze je bezpečně zakomentovat, ačkoli expandují na několikařádkový skript. Moc nás to nemusí trápit, neboť je sice můžeme předefinovat, ale není důvod to dělat, neboť napodobit se nám je podaří stěží.

Mnohem více – normálních – maker rpm při spuštění načítá ze souborů s makry. Které to jsou, to jsme si už popsali. Jejich syntaxe je jednoduchá: Řádky začínající # jsou komentáře; řádky začínající %název_makra definují makro, přičemž zbytek řádku (po přeskočení bílých znaků) se stává tělem makra. K navázání řádků a vytvoření makra s víceřádkovým tělem lze použít zpětné lomítko \ (konec řádku zůstává součástí makra). Příkladů jsme již viděli dost při úvodním nastavení prostředí, i když jsme tehdy možná ještě nevěděli, co vlastně děláme:

%packager Yeti <yeti@physics.muni.cz>

Další makra vznikají z položek hlavičky. Když rpmbuild přečte položku hlavičky, definuje stejnojmenné makro, ovšem malými písmeny: Name dá vzniknout %name, Version definuje %version a pod. Až na Sourcen a Patchn, která se převedou na %SOURCEn a %PATCHn obsahující skutečná umístění souborů (tj. žádná URL). Většinu maker definovaných hlavičkou ovšem není ve spec souboru jak rozumně využít, proto nás nemusí trápit, že předchozí popis, co rpmbuild dělá, je nutno brát doslova. Tedy že po

Requires: libsandals >= 0.7, libsandals-perl, initscripts >= 7.11
Requires: perl

bude tělo makra %requires rovno perl – a po prvním řádku ani památky.

Ve spec souboru ovšem také můžeme definovat makra přímo operátorem %define, jejž už známe:

%define nptl_target_cpu %{_target_cpu}

Definice maker lze i rušit, a to operátorem %undefine:

%undefine nptl_target_cpu

Operátorem %global definujeme makro globálně, což má význam snad jen v %{expand:…}, na nějž zatím nedošla řeč, tudíž všechna naše makra byla zatím dostatečně globální.

Kromě toho lze definovat makra z příkazové řádky. Jednak volbou --define, která definuje makro po načtení souborů s makry, jednak --predefine, která definuje makro ještě před načtením souborů s makry. Jejich argument je jméno makra (bez procenta) následované tělem:

rpm --define '_topdir /home/yeti/tmp/rpmtopdir'

Pozdější definice přepisují dřívější, tudíž definice přímo ve spec souboru nelze bez jeho editace ničím změnit. Shrňme si pořadí definice maker:

1. zabudovaná makra,
2. argumenty --predefine,
3. soubory z macrofiles, v uvedeném pořadí,
4. argumenty --define,
5. spec soubor.

Názvy uživatelských maker musejí být alespoň tři znaky dlouhé.

Vyhodnocování

Jednoduchý způsob, jak můžeme experimentovat s makry, aniž přitom musíme vytvářet nějaké spec soubory, je volba --eval (společně s --define). Expanduje libovolný řetězec s makry, který dostane jako argument, a výsledek vypíše na standardní výstup:

$ rpm --eval 'Hodnota %%_rpmdir: %_rpmdir'
Hodnota %_rpmdir: /home/yeti/src/rpm/RPMS

Testování existence

Neexpandování nedefinovaných maker se nám často nehodí. Naštěstí lze testovat, zda bylo makro definováno, a to operátory %{?…} a %{!?…}. První z nich testuje existenci, druhý neexistenci, a používají se

%{?název_makra:hodnota}
%{!?název_makra:hodnota}

kde hodnota bude výsledkem expanse, když je makro definováno, resp. definováno není. V opačném případě je výsledek expanse prázdný. V hodnotě může být v podstatě cokoli, další makra, definice a pod. Můžeme třeba definovat makro, jen není-li definováno; spustit podmíněně příkaz nebo podmíněně doplnit soubor do sekce %files:

%{!?kerbdir:%define kerbdir /usr}
%{?pam:mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/pam.d}
%{!?nopam:%config(noreplace) /etc/pam.d/su}

Užitečný idiom je také

%{?WITH_SELINUX:1}%{!?WITH_SELINUX:0}

který expanduje na 1, je-li definováno %WITH_SELINUX, a na 0, není-li definováno.

Je-li hodnota prázdná, nebo chybí i dvojtečka, expanduje %{?makro} na hodnotu makra samého, existuje-li; v opačném případě je expanse prázdná. Nezkoušejme ale zařídit, aby se nedefinované makro proměnilo na prázdné, způsobem

%define makro %{?makro}

protože to by vedlo k nekonečné rekursi. Správný způsob (jeden ze správných způsobů) je

%{!?makro:%define makro %nil}

kde %nil je standardní makro expandující na nic. Definováno je zajímavým způsobem:

%define nil %{!?nil}

Můžete nad ním přemýšlet, než se pustíme do pokročilých triků s makry v příští kapitole.

       

Komentáře

[Michal Marek (twofish)]

Ale co může být špatně na řádku ...

Které to jsou, to jsme si už <a href="/clanky/navody/rukovet-balice-rpm-xi-architektury-systemy-platformy">popsali</a> (nebo na jaký článek má vést odkaz)

Užitečný idiom je také %{?WITH_SELINUX:1}%{!?WITH_SELINUX:0} (nebo prohodit 0/1 v následující větě:) který expanduje na 1, je-li definováno %WITH_SELINUX, a na 0, není-li definováno.

[unchallenger]

Odkaz má vést na popis rpmrc v http://www.abclinuxu.cz/clanky/navody/rukovet-balice-rpm-xi-architektury-systemy-platformy.

Prohodit 0 a 1 prosím správce v příkladu, ne ve větě...

[Robert Krátký]

Za odkaz se omlouvám, hloupé přehlédnutí. Číslíčka prohozena.