Binary package guide/it

Oltre al supporto classico alle ebuild, Portage supporta anche la costruzione e l'installazione di pacchetti binari. Questa guida spiega come crearli, installartli, e come configurare un server di pacchetti binari.

Ci sono molte ragioni per cui ad alcuni amministratori di sistemi piace usare pacchetti binari per le installazioni di software su Gentoo:


 * 1) Permette agli amministratori di "risparmiare tempo nel momento in cui sistemi simili devono essere aggiornati". Dover compilare tutto da sorgenti può diventare consumare molto tempo. Mantenere numerosi sistemi simili, alcuni dei quali con hardware più datati, può essere molto più facile se solo un sistema deve compilare tutto da sorgente e gli altri usano i pacchetti binari.
 * 2) Fare aggiornamenti sicuri. Per sistemi di importanza critica per la produzione è importante rimanere "usabili" il maggior tempo possibile. Ciò si può ottenere tramite un server di staging che effettua prima tutti gli aggiornamenti su di sé. Una volta osservato che il server è in uno stato funzionante, gli aggiornamenti possono essere estesi ai sistemi critici. Una variante di questo approccio consiste nell'applicare gli aggiornamenti in un chroot sullo stesso sistema e poi usare i binari creati qui sul sistema reale.
 * 3) Come backup. Spesso i pacchetti binari sono l'unica maniera per ripristinare un sistema non funzionante (per esempio, un compilatore che non funziona). Avere a disposizione dei binari precompilati su un server o localmente può essere di grande aiuto in caso di catena di compilazione danneggiata.
 * 4) Permette di aggiornare sistemi molto vecchi. L'attività di aggiornamento di sistemi molto vecchi può essere ampiamente facilitata usando pacchetti binari. È solitamente utile installare pacchetti binari su vecchi sistemi in quanto essi non necessitano l'installazione o l'aggiornamento delle dipendenze necessarie per la compilazione. I pacchetti binari evitano anche errori nel processo di compilazione in quanto sono già precompilati.

Questa guida si concentrerà sui seguenti argomenti:


 * Creare pacchetti binari.
 * Distribuire i pacchetti ai client.
 * Implementare i pacchetti binari.
 * Mantenere i pacchetti binari.

Verso la fine verranno coperti ulteriori dettagli più avanzati su come gestire i pacchetti binari.

Binary package formats
Starting with portage version 3.0.31, a new binary package format (GPKG) support has been added. The new format was completely redesigned to solve issues with the old design and to include new features, therefore no backward compatibility is provided. If users need to create binary packages for the system using older versions of Portage, please keep using the current XPAK format.

Motivation for the new GPKG format can be found in GLEP 78: Gentoo binary package container format. See also and.

To use new GPKG format, set the BINPKG_FORMAT value in. The default value is xpak.

This guide applies to both formats. See the Understanding the binary package format section for more information on the binary package formats.

Creare pacchetti binari
Esistono tre metodi principali per la creazione di pacchetti binari:


 * 1) Dopo un'installazione regolare, usando l'applicazione.
 * 2) In maniera esplicita durante un'operazione  usando l'opzione.
 * 3) In maniera automatica usando il valore   nella variabile FEATURES di Portage.

Tutti e tre i metodi creeranno un pacchetto binario nella directory indicata dalla variabile PKGDIR (che ha un valore predefinito uguale a ).

Usare quickpkg
L'applicazione prende uno o più atom di dipedenza (o insiemi di pacchetti) e crea pacchetti binari per tutti i pacchetti installati corrispondenti a quell'atom.

Occorre fare una precisazione riguardo questo metodo: esso si basa sui file installati, che possono essere un problema nel caso dei file di configurazione. Gli amministratori cambiano spesso i file di configurazione dopo aver installato del software. Poiché ciò potrebbe far trasparire dati importanti (magari anche confidenziali) nei pacchetti, non include in maniera predefinita tutti i file di configurazione protetti tramite il metodo CONFIG_PROTECT. Per forzare l'inclusione dei file di configurazione, si usino le opzioni  o.

Per esempio, per creare pacchetti binari di tutte le versioni di GCC installate:

To create binary packages for the system set:

Per creare pacchetti binari di tutti i pacchetti installati nel sistema, si usi il simbolo :

Usare --buildpkg come opzione di emerge
Quando si installa del software usando, si può chiedere a Portage di creare pacchetti binari usando l'opzione  :

È anche possibile chiedere a Portage di creare solamente un pacchetto binario ma di non installare il software sul sistema live. Per questo, si può usare l'opzione  :

Quest'ultimo approccio tuttavia richiede che tutte le dipendenze per la compilazione siano state già installate.

Implementare buildpkg come funzionalità di Portage
La maniera più comune per creare automaticamente pacchetti binari ogni qual volta che un pacchetto viene installato da Portage è quella di usare la funzionalità, che può essere impostata in  come di seguito:

Con questa funzionalità attivata, ogni volta che Portage installerà del software esso creerà anche un pacchetto binario.

Escludere la creazione di alcuni pacchetti
È possibile dire a Portage di non creare pacchetti binari per una certa selezione di pacchetti o categorie. Per ottnere ciò, si deve passare l'opzione  ad emerge:

Ciò può essere usato per pacchetti che hanno poco o nulla da beneficiare nell'avere disponibili un pacchetto binario. Dei casi possibili sono le sorgenti del kernel Linux o i pacchetti binari upstream (quelli che terminano con -bin come ).

Binary package compression formats
It is possible to use a specific compression type on binary packages. Currently, the following formats are supported:,  ,  ,  ,  ,  , and. Defaults to. Review and search for BINPKG_COMPRESS for the most up-to-date information.

The compression format can be specified via.

Note that the compression type used might require extra dependencies to be installed, for example, in this case.

Binary package OpenGPG signing
GPG signature allows users to check the creator and integrity of a binary package, and to perform trust management based on keys. The binary package signing feature is disabled by default, to use it users need to enable the  feature. Note that whether this feature is enabled does not affect the signature verification feature.

Users also need to set the BINPKG_GPG_SIGNING_GPG_HOME and BINPKG_GPG_SIGNING_KEY variables for Portage to find the signing key.

Portage will only try to unlock the GPG private key at the beginning. If the user's key will expire over time, then consider enabling  to prevent signing failures.

Configurare un host di pacchetti binari
Portage supporta un grande numero di protocolli per lo scaricamento di pacchetti binari: FTP, FTPS, HTTP, HTTPS e SSH. Ciò lascia spazio a molte implementazioni di host di pacchetti binari diverse.

Non esiste, tuttavia, un metodo "automatico" fornito da Portage per la distribuzione di pacchetti binari. A seconda dell'installazione desiderata sarà necessario scaricare ulteriore software.

Host di pacchetti binari basato sulla rete
Un approccio comune per la distribuzione di pacchetti binari consiste nella creazione di un host di pacchetti binari basato sulla rete.

Si usi un server di rete come lighttpd e lo si configuri per fornire accesso in lettura al percorso  di PKGDIR.

In seguito, sui sistemi client, si configuri di conseguenza la variabile PORTAGE_BINHOST :

Host di pacchetti binari SSH
Per fornire un approccio più autenticato per i pacchetti binari, si può considerare l'uso di SSH.

Quando si usa SSH, è possibile usare la chiave SSH dell'utente root di Linux (senza password in quanto le installazioni devono avvenire in background) per connettersi ad un host di pacchetti binari remoto.

Per questo, è necessario assicurarsi che la chiave SSH dell'utente root sia permessa sul server. Ciò dovrà accadere per ogni macchina che si connetterà all'host SSH:

La variabile PORTAGE_BINHOST dovrà quindi essere come di seguito:

Esportato su NFS
Quando si usano pacchetti binari su una rete interna, può risultare più facile esportare i pacchetti tramite NFS e montarlo sui client.

Il file potrebbe essere così:

Sui client, il percorso può poi essere montato. Un esempio di potrebbe essere:

The NFS share is mounted on the local filesystem, so there is no need to set PORTAGE_BINHOST or use the  option. Instead, follow the normal procedures for installing binary packages, remembering to point PKGDIR to the NFS share so that portage knows where to find the packages:

Usare i pacchetti binari
Affinché i pacchetti binari siano utilizzabili su altri sistemi, essi devono soddisfare alcuni requisiti:


 * Le architetture del client e del server e la variabile CHOST devono corrispondere.
 * Le variabili CFLAGS e CXXFLAGS usate per compilare i pacchetti binari devono essere compatibili con tutti i client.
 * I flag USE per funzionalità di insiemi di istruzioni specifiche del processore (come MMX, SSE, ecc.) devono essere selezionate con attenzione; tutti i client devono supportarli.

The utility can be used to find a subset of CFLAGS that is supported by both the server and client(s). For example, the host might return:

While the client might return:

In this example CFLAGS could be set to  since   is a full subset of. and  are not included as these are not supported but the client. However,  is included as the client does not support. To find which 's are subsets of others, check the [//gcc.gnu.org/onlinedocs/gcc/x86-Options.html gcc manual], if there is no suitable subset set e.g..

Optionally, it is also possible to set  or   to tell gcc to tune code to a specific arch. In contrast to, the   argument does not prevent code from being executed on other processors. For example, to compile code which is compatible with ivybridge and up but is tuned to run best on skylake set CFLAGS to. When  is not set it defaults to whatever   is set to.

When changing  to a lower subset for using binary packages on a client, a full recompilation is required to make sure that all binaries are compatible with the client's processor, to save time packages that are not compiled with e.g. gcc/clang can be excluded:

Similarly, can be used to find a suitable subset of processor specific instruction set USE flags. For example, the host might return:

While the client might return:

In this example CPU_FLAGS_X86 can be set to  in  because these flags are supported by both the client and the host

Oltre a ciò, Portage controllerà se il pacchetto binario viene costruito con gli stessi flag USE attesi dal client. Se un pacchetto viene costruito con una combinazione di flag USE diversa, Portage ignorerà il pacchetto binario (ed userà una compilazione basata su sorgenti) oppure fallirà, a seconda delle opzioni passate al comando al momento dell'invocazione dello stesso (consultare la sezione installazione dei pacchetti binari).

Sui client, sono necessari alcuni cambiamenti di configurazione affinché i pacchetti binari possano essere usati.

Installare i pacchetti binari
Alcune opzioni possono essere passate al comando per informare Portage di usare i pacchetti binari:

Per usare automaticamente installazioni di pacchetti binari, si può aggiungere l'opzione appropriata alla variabile EMERGE_DEFAULT_OPTS :

There is a Portage feature that automatically implements the equivalent of   without the need for updating the EMERGE_DEFAULT_OPTS variable with the   value:

Verify binary package's OpenGPG signature
This feature is only available in GPKG format.

Portage will try to verify the binary package's signature whenever possible, but users must first set up trusted local keys. A GPG key management tool for portage is in the plan, but for now, users have to manage it manually.

The GPG database of portage is stored in by default.

The following script will create a local trusted master key, import key  from keys.openpgp.org, and trust it. Please modify it to a key trusted by the user.

Make sure is global readable, portage will drop root privileges when verifying binary packages.

By default, Portage will only verify GPG signatures when a signature file is found in a package, which allows the user to mix signed and unsigned GPKG binary packages from different sources, and allows to use of old XPAK format binary packages.

If the user needs to force signature verification, the  feature needs to be enabled. This feature assumes that all packages should be signed and rejects any unsigned package. Note that this feature does not support per binhost configuration.

Pulling packages from a binary package host
When using a binary package host, clients need to have the PORTAGE_BINHOST variable set in or the sync-uri variable in. The latter option is preferred over setting the PORTAGE_BINHOST. Without this configuration, the client will not know where the binary packages are stored which results in Portage being unable to retrieve them.

The PORTAGE_BINHOST variable uses a space-separated list of URIs. This allows administrators to use several binary package servers simultaneously. The URI must always point to the directory in which the file resides.

For each binhost, a name can be configured in the brackets. sync-uri must point to the directory in which the file resides. Optionally, priority can be set. When a package exists in multiple binary package repositories, the package is pulled from the binary package host with the highest priority. This way, a preferred binary package host can be set up.

Reinstalling modified binary packages
Passing the  option to  will reinstall every binary that has been rebuilt since the package was installed. This is useful in case rebuilding tools like are run on the binary package server.

A related option is. It causes emerge not to consider binary packages for a re-install if those binary packages have been built before the given time stamp. This is useful to avoid re-installing all packages, if the binary package server had to be rebuild from scratch but  is used otherwise.

Additional client settings
Next to the  feature, Portage also listens to the   feature. This one controls if log files for successful binary package installations should be kept. It is only relevant if the PORT_LOGDIR variable has been set and is enabled by default.

Similar to excluding binary packages for a certain set of packages or categories, clients can be configured to exclude binary package installations for a certain set of packages or categories.

To accomplish this, use the  option:

To enable such additional settings for each emerge command, add the options to the EMERGE_DEFAULT_OPTS variable in the file:

Maintaining binary packages
Exporting and distributing the binary packages will lead to useless storage consumption if the binary package list is not actively maintained.

Removing outdated binary packages
In the package an application called  is provided. It allows for maintaining Portage-related variable files, such as downloaded source code files, but also binary packages.

The following command will remove all binary packages that have no corresponding ebuild in the installed ebuild repositories:

For more details please read the article.

Another tool that can be used is the tool from the  package. However, this tool is a bit less configurable.

To clean up unused binary packages (in the sense of used by the server on which the binary packages are stored):

Maintaining the Packages file
Inside the packages directory exists a manifest file called. This file acts as a cache for the metadata of all binary packages in the packages directory. The file is updated whenever Portage adds a binary package to the directory. Similarly, updates it when it removes binary packages.

If for some reason binary packages are simply deleted or copied into the packages directory, or the file gets corrupted or deleted, then it must be recreated. This is done using command:

Building for other architectures
is a tool that will easily build cross compile toolchains to allow setting up a binary host for a different architecture, for example for a device like a from a more powerful desktop PC.

An installation guide for this package can be found at the page.

Build a cross compiler
Using crossdev with the following command can build a toolchain for the desired system:

For the rest of this section, the example target will be for a Raspberry Pi 4:

After this has built, a toolchain will have been created in, and will look like a bare bones Gentoo install where it is possible to edit settings as normal.

Basic setup
Removing the  flag from the USE line in  is generally recommended in a setup like this:

Profiles
List available profiles for the device by running:

Next, select the profile that best suits:

Build a single package
To build a single binary package for use on the device, use the following:

Build world file
To build every package in the world file, then the following command is needed:

Binary location
By default, all binary packages will be stored in, so this is the location needed to be selected when setting up a binary package host.

Creating snapshots of the packages directory
When deploying binary packages for a large number of client systems it might become worthwhile to create snapshots of the packages directory. The client systems then do not use the packages directory directly but use binary packages from the snapshot.

Snapshots can be created using the or  tool. It takes four arguments:


 * 1) A source directory (the path to the packages directory).
 * 2) A target directory (that must not exist).
 * 3) A URI.
 * 4) A binary package server directory.

The files from the package directory are copied to the target directory. A file is then created inside the binary package server directory (fourth argument) with the provided URI.

Client systems need to use an URI that points to the binary package server directory. From there they will be redirected to the URI that was given to. This URI has to refer to the target directory.

XPAK format
XPAK format binary packages created by Portage have the file name ending with. These files consist of two parts:


 * 1) A  archive containing the files that will be installed on the system.
 * 2) A  archive containing package metadata, the ebuild, and the environment file.

See for a description of the format.

In some tools exists that are able to split or create  and  files.

The following command will split the into a  and an  file:

The file can be examined using the  utility.

To list the contents:

The next command will extract a file called which contains the enabled USE flags for this package:

GPKG format
GPKG format binary packages created by Portage have the file name ending with. These files consist of four parts at least:


 * 1) A  empty file that used to identify the format.
 * 2) A  archive containing package metadata, the ebuild, and the environment file.
 * 3) A  archive containing the files that will be installed on the system.
 * 4) A  file containing all files checksum that will be used to check for file corruption.
 * 5) Multiple optional  files containing OpenGPG signature are used for integrity checking and trust management.

The format can be extracted by tar without the need for additional tools.

The PKGDIR layout
The currently used format version 2 has the following layout:

The file is the major improvement (and also the trigger for Portage to know that the binary package directory uses version 2) over the first binary package directory layout (version 1). In version 1, all binary packages were also hosted inside a single directory (called ) and the category directories only had symbolic links to the binary packages inside the directory.

In portage-3.0.15 and later, FEATURES=binpkg-multi-instance is enabled by default:

Unpacking with quickunpkg
Zoobab wrote a simple shell tool named quickunpkg to quickly unpack files.

External resources
quickpkg man page.