2005-01-19 16:39:47 +00:00
|
|
|
#ifndef __DERIVATIONS_H
|
|
|
|
#define __DERIVATIONS_H
|
2003-06-16 13:33:38 +00:00
|
|
|
|
2003-11-16 17:46:31 +00:00
|
|
|
#include "aterm.hh"
|
2003-07-15 16:28:54 +00:00
|
|
|
#include "store.hh"
|
2003-06-16 13:33:38 +00:00
|
|
|
|
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Extension of derivations in the Nix store. */
|
|
|
|
const string drvExtension = ".drv";
|
2003-06-27 09:55:31 +00:00
|
|
|
|
2003-06-16 13:33:38 +00:00
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Abstract syntax of derivations. */
|
* Removed the `id' attribute hack.
* Formalise the notion of fixed-output derivations, i.e., derivations
for which a cryptographic hash of the output is known in advance.
Changes to such derivations should not propagate upwards through the
dependency graph. Previously this was done by specifying the hash
component of the output path through the `id' attribute, but this is
insecure since you can lie about it (i.e., you can specify any hash
and then produce a completely different output). Now the
responsibility for checking the output is moved from the builder to
Nix itself.
A fixed-output derivation can be created by specifying the
`outputHash' and `outputHashAlgo' attributes, the latter taking
values `md5', `sha1', and `sha256', and the former specifying the
actual hash in hexadecimal or in base-32 (auto-detected by looking
at the length of the attribute value). MD5 is included for
compatibility but should be considered deprecated.
* Removed the `drvPath' pseudo-attribute in derivation results. It's
no longer necessary.
* Cleaned up the support for multiple output paths in derivation store
expressions. Each output now has a unique identifier (e.g., `out',
`devel', `docs'). Previously there was no way to tell output paths
apart at the store expression level.
* `nix-hash' now has a flag `--base32' to specify that the hash should
be printed in base-32 notation.
* `fetchurl' accepts parameters `sha256' and `sha1' in addition to
`md5'.
* `nix-prefetch-url' now prints out a SHA-1 hash in base-32. (TODO: a
flag to specify the hash.)
2005-01-17 16:55:19 +00:00
|
|
|
|
|
|
|
struct DerivationOutput
|
|
|
|
{
|
|
|
|
Path path;
|
|
|
|
string hashAlgo; /* hash used for expected hash computation */
|
|
|
|
string hash; /* expected hash, may be null */
|
|
|
|
DerivationOutput()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
DerivationOutput(Path path, string hashAlgo, string hash)
|
|
|
|
{
|
|
|
|
this->path = path;
|
|
|
|
this->hashAlgo = hashAlgo;
|
|
|
|
this->hash = hash;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef map<string, DerivationOutput> DerivationOutputs;
|
2005-01-20 14:10:19 +00:00
|
|
|
|
|
|
|
/* For inputs that are sub-derivations, we specify exactly which
|
|
|
|
output IDs we are interested in. */
|
|
|
|
typedef map<Path, StringSet> DerivationInputs;
|
|
|
|
|
2003-08-20 14:11:40 +00:00
|
|
|
typedef map<string, string> StringPairs;
|
2003-07-20 19:29:38 +00:00
|
|
|
|
2003-10-07 12:27:49 +00:00
|
|
|
struct Derivation
|
2003-07-20 19:29:38 +00:00
|
|
|
{
|
* Removed the `id' attribute hack.
* Formalise the notion of fixed-output derivations, i.e., derivations
for which a cryptographic hash of the output is known in advance.
Changes to such derivations should not propagate upwards through the
dependency graph. Previously this was done by specifying the hash
component of the output path through the `id' attribute, but this is
insecure since you can lie about it (i.e., you can specify any hash
and then produce a completely different output). Now the
responsibility for checking the output is moved from the builder to
Nix itself.
A fixed-output derivation can be created by specifying the
`outputHash' and `outputHashAlgo' attributes, the latter taking
values `md5', `sha1', and `sha256', and the former specifying the
actual hash in hexadecimal or in base-32 (auto-detected by looking
at the length of the attribute value). MD5 is included for
compatibility but should be considered deprecated.
* Removed the `drvPath' pseudo-attribute in derivation results. It's
no longer necessary.
* Cleaned up the support for multiple output paths in derivation store
expressions. Each output now has a unique identifier (e.g., `out',
`devel', `docs'). Previously there was no way to tell output paths
apart at the store expression level.
* `nix-hash' now has a flag `--base32' to specify that the hash should
be printed in base-32 notation.
* `fetchurl' accepts parameters `sha256' and `sha1' in addition to
`md5'.
* `nix-prefetch-url' now prints out a SHA-1 hash in base-32. (TODO: a
flag to specify the hash.)
2005-01-17 16:55:19 +00:00
|
|
|
DerivationOutputs outputs; /* keyed on symbolic IDs */
|
2005-01-20 14:10:19 +00:00
|
|
|
DerivationInputs inputDrvs; /* inputs that are sub-derivations */
|
2005-01-19 11:16:11 +00:00
|
|
|
PathSet inputSrcs; /* inputs that are sources */
|
2003-07-20 19:29:38 +00:00
|
|
|
string platform;
|
2003-10-08 15:06:59 +00:00
|
|
|
Path builder;
|
2003-08-15 12:32:37 +00:00
|
|
|
Strings args;
|
2003-07-20 19:29:38 +00:00
|
|
|
StringPairs env;
|
|
|
|
};
|
|
|
|
|
2003-07-15 16:28:54 +00:00
|
|
|
|
2003-06-27 13:55:12 +00:00
|
|
|
/* Hash an aterm. */
|
|
|
|
Hash hashTerm(ATerm t);
|
2003-06-16 13:33:38 +00:00
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Write a derivation to the Nix store, and return its path. */
|
|
|
|
Path writeDerivation(const Derivation & drv, const string & name);
|
2003-07-10 18:48:11 +00:00
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Parse a derivation. */
|
2005-01-19 11:16:11 +00:00
|
|
|
Derivation parseDerivation(ATerm t);
|
2003-07-16 11:05:59 +00:00
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Parse a derivation. */
|
2005-01-19 11:16:11 +00:00
|
|
|
ATerm unparseDerivation(const Derivation & drv);
|
2003-07-15 22:28:27 +00:00
|
|
|
|
2005-01-19 14:36:00 +00:00
|
|
|
/* Check whether a file name ends with the extensions for
|
|
|
|
derivations. */
|
|
|
|
bool isDerivation(const string & fileName);
|
|
|
|
|
2003-06-16 13:33:38 +00:00
|
|
|
|
2005-01-19 16:39:47 +00:00
|
|
|
#endif /* !__DERIVATIONS_H */
|