2012-07-18 18:59:03 +00:00
|
|
|
|
#pragma once
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
|
|
|
|
#include "types.hh"
|
2015-07-19 23:16:16 +00:00
|
|
|
|
#include "util.hh"
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
namespace nix {
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* Abstract destination of binary data. */
|
2015-07-19 23:16:16 +00:00
|
|
|
|
struct Sink
|
2006-11-30 19:19:59 +00:00
|
|
|
|
{
|
|
|
|
|
virtual ~Sink() { }
|
2011-12-15 16:19:53 +00:00
|
|
|
|
virtual void operator () (const unsigned char * data, size_t len) = 0;
|
2016-02-24 10:39:56 +00:00
|
|
|
|
virtual bool good() { return true; }
|
2011-12-15 16:19:53 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* A buffered abstract sink. */
|
|
|
|
|
struct BufferedSink : Sink
|
|
|
|
|
{
|
|
|
|
|
size_t bufSize, bufPos;
|
|
|
|
|
unsigned char * buffer;
|
|
|
|
|
|
|
|
|
|
BufferedSink(size_t bufSize = 32 * 1024)
|
|
|
|
|
: bufSize(bufSize), bufPos(0), buffer(0) { }
|
|
|
|
|
~BufferedSink();
|
2011-12-16 19:44:13 +00:00
|
|
|
|
|
2016-02-24 10:39:56 +00:00
|
|
|
|
void operator () (const unsigned char * data, size_t len) override;
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
void flush();
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
virtual void write(const unsigned char * data, size_t len) = 0;
|
2006-11-30 19:19:59 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* Abstract source of binary data. */
|
|
|
|
|
struct Source
|
|
|
|
|
{
|
|
|
|
|
virtual ~Source() { }
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
/* Store exactly ‘len’ bytes in the buffer pointed to by ‘data’.
|
2011-12-16 19:44:13 +00:00
|
|
|
|
It blocks until all the requested data is available, or throws
|
|
|
|
|
an error if it is not going to be available. */
|
|
|
|
|
void operator () (unsigned char * data, size_t len);
|
|
|
|
|
|
|
|
|
|
/* Store up to ‘len’ in the buffer pointed to by ‘data’, and
|
|
|
|
|
return the number of bytes stored. If blocks until at least
|
|
|
|
|
one byte is available. */
|
|
|
|
|
virtual size_t read(unsigned char * data, size_t len) = 0;
|
2016-02-24 10:39:56 +00:00
|
|
|
|
|
|
|
|
|
virtual bool good() { return true; }
|
2006-11-30 19:19:59 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
/* A buffered abstract source. */
|
|
|
|
|
struct BufferedSource : Source
|
2006-11-30 19:19:59 +00:00
|
|
|
|
{
|
2011-12-15 16:19:53 +00:00
|
|
|
|
size_t bufSize, bufPosIn, bufPosOut;
|
2011-12-14 23:30:06 +00:00
|
|
|
|
unsigned char * buffer;
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
BufferedSource(size_t bufSize = 32 * 1024)
|
|
|
|
|
: bufSize(bufSize), bufPosIn(0), bufPosOut(0), buffer(0) { }
|
|
|
|
|
~BufferedSource();
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2016-02-24 10:39:56 +00:00
|
|
|
|
size_t read(unsigned char * data, size_t len) override;
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2013-08-10 21:36:16 +00:00
|
|
|
|
/* Underlying read call, to be overridden. */
|
2011-12-16 19:44:13 +00:00
|
|
|
|
virtual size_t readUnbuffered(unsigned char * data, size_t len) = 0;
|
2013-06-07 13:02:14 +00:00
|
|
|
|
|
|
|
|
|
bool hasData();
|
2006-11-30 19:19:59 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
/* A sink that writes data to a file descriptor. */
|
|
|
|
|
struct FdSink : BufferedSink
|
2006-11-30 19:19:59 +00:00
|
|
|
|
{
|
|
|
|
|
int fd;
|
2016-02-26 15:16:08 +00:00
|
|
|
|
bool warn = false;
|
|
|
|
|
size_t written = 0;
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
2016-02-26 15:16:08 +00:00
|
|
|
|
FdSink() : fd(-1) { }
|
|
|
|
|
FdSink(int fd) : fd(fd) { }
|
2011-12-16 15:45:42 +00:00
|
|
|
|
~FdSink();
|
2015-07-19 23:16:16 +00:00
|
|
|
|
|
2016-02-24 10:39:56 +00:00
|
|
|
|
void write(const unsigned char * data, size_t len) override;
|
|
|
|
|
|
|
|
|
|
bool good() override;
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
bool _good = true;
|
2011-12-15 16:19:53 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* A source that reads data from a file descriptor. */
|
|
|
|
|
struct FdSource : BufferedSource
|
|
|
|
|
{
|
|
|
|
|
int fd;
|
2016-02-26 15:16:08 +00:00
|
|
|
|
size_t read = 0;
|
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
FdSource() : fd(-1) { }
|
|
|
|
|
FdSource(int fd) : fd(fd) { }
|
2016-02-24 10:39:56 +00:00
|
|
|
|
size_t readUnbuffered(unsigned char * data, size_t len) override;
|
|
|
|
|
bool good() override;
|
|
|
|
|
private:
|
|
|
|
|
bool _good = true;
|
2006-11-30 19:19:59 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2006-12-12 23:05:01 +00:00
|
|
|
|
/* A sink that writes data to a string. */
|
|
|
|
|
struct StringSink : Sink
|
|
|
|
|
{
|
2016-03-04 15:49:56 +00:00
|
|
|
|
ref<std::string> s;
|
|
|
|
|
StringSink() : s(make_ref<std::string>()) { };
|
|
|
|
|
StringSink(ref<std::string> s) : s(s) { };
|
2016-02-24 10:39:56 +00:00
|
|
|
|
void operator () (const unsigned char * data, size_t len) override;
|
2006-12-12 23:05:01 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* A source that reads data from a string. */
|
|
|
|
|
struct StringSource : Source
|
|
|
|
|
{
|
2008-12-03 17:30:32 +00:00
|
|
|
|
const string & s;
|
2011-12-15 16:19:53 +00:00
|
|
|
|
size_t pos;
|
2008-12-03 17:30:32 +00:00
|
|
|
|
StringSource(const string & _s) : s(_s), pos(0) { }
|
2016-02-24 10:39:56 +00:00
|
|
|
|
size_t read(unsigned char * data, size_t len) override;
|
2006-12-12 23:05:01 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
void writePadding(size_t len, Sink & sink);
|
2011-12-16 21:29:46 +00:00
|
|
|
|
void writeString(const unsigned char * buf, size_t len, Sink & sink);
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
2015-07-19 23:16:16 +00:00
|
|
|
|
inline Sink & operator << (Sink & sink, uint64_t n)
|
|
|
|
|
{
|
|
|
|
|
unsigned char buf[8];
|
|
|
|
|
buf[0] = n & 0xff;
|
|
|
|
|
buf[1] = (n >> 8) & 0xff;
|
|
|
|
|
buf[2] = (n >> 16) & 0xff;
|
|
|
|
|
buf[3] = (n >> 24) & 0xff;
|
|
|
|
|
buf[4] = (n >> 32) & 0xff;
|
|
|
|
|
buf[5] = (n >> 40) & 0xff;
|
|
|
|
|
buf[6] = (n >> 48) & 0xff;
|
|
|
|
|
buf[7] = (n >> 56) & 0xff;
|
|
|
|
|
sink(buf, sizeof(buf));
|
|
|
|
|
return sink;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Sink & operator << (Sink & sink, const string & s);
|
|
|
|
|
Sink & operator << (Sink & sink, const Strings & s);
|
|
|
|
|
Sink & operator << (Sink & sink, const StringSet & s);
|
Allow remote builds without sending the derivation closure
Previously, to build a derivation remotely, we had to copy the entire
closure of the .drv file to the remote machine, even though we only
need the top-level derivation. This is very wasteful: the closure can
contain thousands of store paths, and in some Hydra use cases, include
source paths that are very large (e.g. Git/Mercurial checkouts).
So now there is a new operation, StoreAPI::buildDerivation(), that
performs a build from an in-memory representation of a derivation
(BasicDerivation) rather than from a on-disk .drv file. The only files
that need to be in the Nix store are the sources of the derivation
(drv.inputSrcs), and the needed output paths of the dependencies (as
described by drv.inputDrvs). "nix-store --serve" exposes this
interface.
Note that this is a privileged operation, because you can construct a
derivation that builds any store path whatsoever. Fixing this will
require changing the hashing scheme (i.e., the output paths should be
computed from the other fields in BasicDerivation, allowing them to be
verified without access to other derivations). However, this would be
quite nice because it would allow .drv-free building (e.g. "nix-env
-i" wouldn't have to write any .drv files to disk).
Fixes #173.
2015-07-17 15:57:40 +00:00
|
|
|
|
|
|
|
|
|
|
2011-12-15 16:19:53 +00:00
|
|
|
|
void readPadding(size_t len, Source & source);
|
2006-11-30 19:19:59 +00:00
|
|
|
|
unsigned int readInt(Source & source);
|
2008-06-18 09:34:17 +00:00
|
|
|
|
unsigned long long readLongLong(Source & source);
|
2011-12-16 21:29:46 +00:00
|
|
|
|
size_t readString(unsigned char * buf, size_t max, Source & source);
|
2006-11-30 19:19:59 +00:00
|
|
|
|
string readString(Source & source);
|
2011-12-16 22:31:25 +00:00
|
|
|
|
template<class T> T readStrings(Source & source);
|
2006-11-30 22:43:55 +00:00
|
|
|
|
|
Allow remote builds without sending the derivation closure
Previously, to build a derivation remotely, we had to copy the entire
closure of the .drv file to the remote machine, even though we only
need the top-level derivation. This is very wasteful: the closure can
contain thousands of store paths, and in some Hydra use cases, include
source paths that are very large (e.g. Git/Mercurial checkouts).
So now there is a new operation, StoreAPI::buildDerivation(), that
performs a build from an in-memory representation of a derivation
(BasicDerivation) rather than from a on-disk .drv file. The only files
that need to be in the Nix store are the sources of the derivation
(drv.inputSrcs), and the needed output paths of the dependencies (as
described by drv.inputDrvs). "nix-store --serve" exposes this
interface.
Note that this is a privileged operation, because you can construct a
derivation that builds any store path whatsoever. Fixing this will
require changing the hashing scheme (i.e., the output paths should be
computed from the other fields in BasicDerivation, allowing them to be
verified without access to other derivations). However, this would be
quite nice because it would allow .drv-free building (e.g. "nix-env
-i" wouldn't have to write any .drv files to disk).
Fixes #173.
2015-07-17 15:57:40 +00:00
|
|
|
|
Source & operator >> (Source & in, string & s);
|
2015-09-03 10:56:59 +00:00
|
|
|
|
Source & operator >> (Source & in, unsigned int & n);
|
Allow remote builds without sending the derivation closure
Previously, to build a derivation remotely, we had to copy the entire
closure of the .drv file to the remote machine, even though we only
need the top-level derivation. This is very wasteful: the closure can
contain thousands of store paths, and in some Hydra use cases, include
source paths that are very large (e.g. Git/Mercurial checkouts).
So now there is a new operation, StoreAPI::buildDerivation(), that
performs a build from an in-memory representation of a derivation
(BasicDerivation) rather than from a on-disk .drv file. The only files
that need to be in the Nix store are the sources of the derivation
(drv.inputSrcs), and the needed output paths of the dependencies (as
described by drv.inputDrvs). "nix-store --serve" exposes this
interface.
Note that this is a privileged operation, because you can construct a
derivation that builds any store path whatsoever. Fixing this will
require changing the hashing scheme (i.e., the output paths should be
computed from the other fields in BasicDerivation, allowing them to be
verified without access to other derivations). However, this would be
quite nice because it would allow .drv-free building (e.g. "nix-env
-i" wouldn't have to write any .drv files to disk).
Fixes #173.
2015-07-17 15:57:40 +00:00
|
|
|
|
|
2006-11-30 19:19:59 +00:00
|
|
|
|
|
2009-03-22 17:36:43 +00:00
|
|
|
|
MakeError(SerialisationError, Error)
|
|
|
|
|
|
|
|
|
|
|
2006-11-30 19:19:59 +00:00
|
|
|
|
}
|