2012-07-18 21:59:03 +03:00
|
|
|
|
#pragma once
|
2003-04-04 19:14:56 +03:00
|
|
|
|
|
2006-09-05 00:06:23 +03:00
|
|
|
|
#include "types.hh"
|
2016-04-25 16:26:07 +03:00
|
|
|
|
#include "logging.hh"
|
2003-04-08 15:00:51 +03:00
|
|
|
|
|
2003-10-22 13:48:22 +03:00
|
|
|
|
#include <sys/types.h>
|
2010-12-13 15:32:58 +02:00
|
|
|
|
#include <sys/stat.h>
|
2003-10-22 13:48:22 +03:00
|
|
|
|
#include <dirent.h>
|
2003-04-08 15:00:51 +03:00
|
|
|
|
#include <unistd.h>
|
2004-01-15 22:23:55 +02:00
|
|
|
|
#include <signal.h>
|
2016-09-20 16:39:08 +03:00
|
|
|
|
|
2014-07-10 17:50:51 +03:00
|
|
|
|
#include <functional>
|
2016-01-19 14:00:02 +02:00
|
|
|
|
#include <limits>
|
2009-11-24 15:28:46 +02:00
|
|
|
|
#include <cstdio>
|
2016-09-20 16:39:08 +03:00
|
|
|
|
#include <map>
|
2017-03-08 23:24:10 +02:00
|
|
|
|
#include <sstream>
|
2017-03-15 15:40:47 +02:00
|
|
|
|
#include <experimental/optional>
|
2009-11-24 14:56:26 +02:00
|
|
|
|
|
2015-11-07 05:51:33 +02:00
|
|
|
|
#ifndef HAVE_STRUCT_DIRENT_D_TYPE
|
|
|
|
|
#define DT_UNKNOWN 0
|
|
|
|
|
#define DT_REG 1
|
|
|
|
|
#define DT_LNK 2
|
|
|
|
|
#define DT_DIR 3
|
|
|
|
|
#endif
|
2003-06-27 16:55:12 +03:00
|
|
|
|
|
2006-09-05 00:06:23 +03:00
|
|
|
|
namespace nix {
|
2003-10-07 17:37:41 +03:00
|
|
|
|
|
|
|
|
|
|
2004-05-12 12:35:51 +03:00
|
|
|
|
/* Return an environment variable. */
|
|
|
|
|
string getEnv(const string & key, const string & def = "");
|
|
|
|
|
|
2016-09-20 16:39:08 +03:00
|
|
|
|
/* Get the entire environment. */
|
|
|
|
|
std::map<std::string, std::string> getEnv();
|
|
|
|
|
|
2003-06-16 16:33:38 +03:00
|
|
|
|
/* Return an absolutized path, resolving paths relative to the
|
2003-07-07 12:25:26 +03:00
|
|
|
|
specified directory, or the current directory otherwise. The path
|
|
|
|
|
is also canonicalised. */
|
2003-10-07 17:37:41 +03:00
|
|
|
|
Path absPath(Path path, Path dir = "");
|
2003-06-16 16:33:38 +03:00
|
|
|
|
|
2004-03-27 19:58:04 +02:00
|
|
|
|
/* Canonicalise a path by removing all `.' or `..' components and
|
2006-01-08 19:16:03 +02:00
|
|
|
|
double or trailing slashes. Optionally resolves all symlink
|
|
|
|
|
components such that each component of the resulting path is *not*
|
|
|
|
|
a symbolic link. */
|
|
|
|
|
Path canonPath(const Path & path, bool resolveSymlinks = false);
|
2003-07-07 12:25:26 +03:00
|
|
|
|
|
2004-03-27 19:58:04 +02:00
|
|
|
|
/* Return the directory part of the given canonical path, i.e.,
|
|
|
|
|
everything before the final `/'. If the path is the root or an
|
|
|
|
|
immediate child thereof (e.g., `/foo'), this means an empty string
|
|
|
|
|
is returned. */
|
2003-10-07 17:37:41 +03:00
|
|
|
|
Path dirOf(const Path & path);
|
2003-06-16 16:33:38 +03:00
|
|
|
|
|
2004-03-27 19:58:04 +02:00
|
|
|
|
/* Return the base name of the given canonical path, i.e., everything
|
|
|
|
|
following the final `/'. */
|
2003-10-07 17:37:41 +03:00
|
|
|
|
string baseNameOf(const Path & path);
|
2003-04-08 15:00:51 +03:00
|
|
|
|
|
2013-07-12 15:01:25 +03:00
|
|
|
|
/* Check whether a given path is a descendant of the given
|
|
|
|
|
directory. */
|
|
|
|
|
bool isInDir(const Path & path, const Path & dir);
|
|
|
|
|
|
2010-12-13 15:32:58 +02:00
|
|
|
|
/* Get status of `path'. */
|
|
|
|
|
struct stat lstat(const Path & path);
|
|
|
|
|
|
2003-07-08 16:22:08 +03:00
|
|
|
|
/* Return true iff the given path exists. */
|
2003-10-07 17:37:41 +03:00
|
|
|
|
bool pathExists(const Path & path);
|
2003-04-08 15:00:51 +03:00
|
|
|
|
|
2004-01-05 18:26:43 +02:00
|
|
|
|
/* Read the contents (target) of a symbolic link. The result is not
|
|
|
|
|
in any way canonicalised. */
|
|
|
|
|
Path readLink(const Path & path);
|
|
|
|
|
|
2005-02-01 15:48:46 +02:00
|
|
|
|
bool isLink(const Path & path);
|
|
|
|
|
|
2003-11-19 19:27:16 +02:00
|
|
|
|
/* Read the contents of a directory. The entries `.' and `..' are
|
|
|
|
|
removed. */
|
2014-08-01 17:37:47 +03:00
|
|
|
|
struct DirEntry
|
|
|
|
|
{
|
|
|
|
|
string name;
|
|
|
|
|
ino_t ino;
|
|
|
|
|
unsigned char type; // one of DT_*
|
2014-08-01 18:30:51 +03:00
|
|
|
|
DirEntry(const string & name, ino_t ino, unsigned char type)
|
|
|
|
|
: name(name), ino(ino), type(type) { }
|
2014-08-01 17:37:47 +03:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef vector<DirEntry> DirEntries;
|
|
|
|
|
|
|
|
|
|
DirEntries readDirectory(const Path & path);
|
2003-11-19 19:27:16 +02:00
|
|
|
|
|
2014-10-03 23:37:51 +03:00
|
|
|
|
unsigned char getFileType(const Path & path);
|
|
|
|
|
|
2005-02-02 00:07:48 +02:00
|
|
|
|
/* Read the contents of a file into a string. */
|
|
|
|
|
string readFile(int fd);
|
2012-08-20 22:27:30 +03:00
|
|
|
|
string readFile(const Path & path, bool drain = false);
|
2005-02-02 00:07:48 +02:00
|
|
|
|
|
2005-02-09 11:50:29 +02:00
|
|
|
|
/* Write a string to a file. */
|
2017-02-16 16:42:49 +02:00
|
|
|
|
void writeFile(const Path & path, const string & s, mode_t mode = 0666);
|
2005-02-09 11:50:29 +02:00
|
|
|
|
|
2009-03-28 21:29:55 +02:00
|
|
|
|
/* Read a line from a file descriptor. */
|
|
|
|
|
string readLine(int fd);
|
|
|
|
|
|
|
|
|
|
/* Write a line to a file descriptor. */
|
|
|
|
|
void writeLine(int fd, string s);
|
|
|
|
|
|
2003-06-23 17:40:49 +03:00
|
|
|
|
/* Delete a path; i.e., in the case of a directory, it is deleted
|
2016-02-24 18:44:12 +02:00
|
|
|
|
recursively. It's not an error if the path does not exist. The
|
|
|
|
|
second variant returns the number of bytes and blocks freed. */
|
2003-10-07 17:37:41 +03:00
|
|
|
|
void deletePath(const Path & path);
|
2003-08-22 23:12:44 +03:00
|
|
|
|
|
2012-08-02 05:34:46 +03:00
|
|
|
|
void deletePath(const Path & path, unsigned long long & bytesFreed);
|
2005-12-15 23:11:39 +02:00
|
|
|
|
|
2003-10-02 14:55:38 +03:00
|
|
|
|
/* Create a temporary directory. */
|
2008-03-27 15:45:17 +02:00
|
|
|
|
Path createTempDir(const Path & tmpRoot = "", const Path & prefix = "nix",
|
2012-07-26 22:04:40 +03:00
|
|
|
|
bool includePid = true, bool useGlobalCounter = true, mode_t mode = 0755);
|
2003-10-02 14:55:38 +03:00
|
|
|
|
|
2017-04-20 15:58:16 +03:00
|
|
|
|
/* Return $XDG_CACHE_HOME or $HOME/.cache. */
|
2016-04-20 15:12:38 +03:00
|
|
|
|
Path getCacheDir();
|
|
|
|
|
|
2017-04-20 15:58:16 +03:00
|
|
|
|
/* Return $XDG_CONFIG_HOME or $HOME/.config. */
|
|
|
|
|
Path getConfigDir();
|
|
|
|
|
|
2017-04-25 19:56:29 +03:00
|
|
|
|
/* Return $XDG_DATA_HOME or $HOME/.local/share. */
|
|
|
|
|
Path getDataDir();
|
|
|
|
|
|
2007-10-27 03:46:59 +03:00
|
|
|
|
/* Create a directory and all its parents, if necessary. Returns the
|
|
|
|
|
list of created directories, in order of creation. */
|
|
|
|
|
Paths createDirs(const Path & path);
|
2005-03-24 19:46:38 +02:00
|
|
|
|
|
2014-02-28 00:17:53 +02:00
|
|
|
|
/* Create a symlink. */
|
|
|
|
|
void createSymlink(const Path & target, const Path & link);
|
|
|
|
|
|
2015-04-09 12:42:04 +03:00
|
|
|
|
/* Atomically create or replace a symlink. */
|
|
|
|
|
void replaceSymlink(const Path & target, const Path & link);
|
|
|
|
|
|
2003-11-22 17:58:34 +02:00
|
|
|
|
|
2003-07-21 00:11:43 +03:00
|
|
|
|
/* Wrappers arount read()/write() that read/write exactly the
|
|
|
|
|
requested number of bytes. */
|
|
|
|
|
void readFull(int fd, unsigned char * buf, size_t count);
|
2016-09-16 19:52:42 +03:00
|
|
|
|
void writeFull(int fd, const unsigned char * buf, size_t count, bool allowInterrupts = true);
|
|
|
|
|
void writeFull(int fd, const string & s, bool allowInterrupts = true);
|
2003-07-21 00:11:43 +03:00
|
|
|
|
|
2006-12-04 19:17:13 +02:00
|
|
|
|
MakeError(EndOfFile, Error)
|
|
|
|
|
|
2003-07-21 00:11:43 +03:00
|
|
|
|
|
2006-07-20 15:17:25 +03:00
|
|
|
|
/* Read a file descriptor until EOF occurs. */
|
|
|
|
|
string drainFD(int fd);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-10-22 13:48:22 +03:00
|
|
|
|
/* Automatic cleanup of resources. */
|
|
|
|
|
|
2006-12-04 19:17:13 +02:00
|
|
|
|
|
2003-10-22 13:48:22 +03:00
|
|
|
|
class AutoDelete
|
|
|
|
|
{
|
2006-12-13 01:05:01 +02:00
|
|
|
|
Path path;
|
2003-10-22 13:48:22 +03:00
|
|
|
|
bool del;
|
2013-01-03 14:00:46 +02:00
|
|
|
|
bool recursive;
|
2003-10-22 13:48:22 +03:00
|
|
|
|
public:
|
2015-11-16 12:53:10 +02:00
|
|
|
|
AutoDelete();
|
2007-10-27 03:46:59 +03:00
|
|
|
|
AutoDelete(const Path & p, bool recursive = true);
|
2003-10-22 13:48:22 +03:00
|
|
|
|
~AutoDelete();
|
|
|
|
|
void cancel();
|
2015-11-16 12:53:10 +02:00
|
|
|
|
void reset(const Path & p, bool recursive = true);
|
2015-10-01 17:47:43 +03:00
|
|
|
|
operator Path() const { return path; }
|
2003-10-22 13:48:22 +03:00
|
|
|
|
};
|
|
|
|
|
|
2004-06-22 12:51:44 +03:00
|
|
|
|
|
2003-10-22 13:48:22 +03:00
|
|
|
|
class AutoCloseFD
|
|
|
|
|
{
|
|
|
|
|
int fd;
|
2016-07-11 22:44:44 +03:00
|
|
|
|
void close();
|
2003-10-22 13:48:22 +03:00
|
|
|
|
public:
|
|
|
|
|
AutoCloseFD();
|
|
|
|
|
AutoCloseFD(int fd);
|
2016-07-11 22:44:44 +03:00
|
|
|
|
AutoCloseFD(const AutoCloseFD & fd) = delete;
|
|
|
|
|
AutoCloseFD(AutoCloseFD&& fd);
|
2003-10-22 13:48:22 +03:00
|
|
|
|
~AutoCloseFD();
|
2016-07-11 22:44:44 +03:00
|
|
|
|
AutoCloseFD& operator =(const AutoCloseFD & fd) = delete;
|
|
|
|
|
AutoCloseFD& operator =(AutoCloseFD&& fd);
|
|
|
|
|
int get() const;
|
|
|
|
|
explicit operator bool() const;
|
|
|
|
|
int release();
|
2004-06-15 16:49:42 +03:00
|
|
|
|
};
|
|
|
|
|
|
2004-06-22 12:51:44 +03:00
|
|
|
|
|
2004-06-15 16:49:42 +03:00
|
|
|
|
class Pipe
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
AutoCloseFD readSide, writeSide;
|
|
|
|
|
void create();
|
2003-10-22 13:48:22 +03:00
|
|
|
|
};
|
|
|
|
|
|
2004-06-22 12:51:44 +03:00
|
|
|
|
|
2017-01-16 23:39:27 +02:00
|
|
|
|
struct DIRDeleter
|
2003-10-22 13:48:22 +03:00
|
|
|
|
{
|
2017-01-16 23:39:27 +02:00
|
|
|
|
void operator()(DIR * dir) const {
|
|
|
|
|
closedir(dir);
|
|
|
|
|
}
|
2003-10-22 13:48:22 +03:00
|
|
|
|
};
|
|
|
|
|
|
2017-01-16 23:39:27 +02:00
|
|
|
|
typedef std::unique_ptr<DIR, DIRDeleter> AutoCloseDir;
|
|
|
|
|
|
2003-10-22 13:48:22 +03:00
|
|
|
|
|
2004-06-22 12:51:44 +03:00
|
|
|
|
class Pid
|
|
|
|
|
{
|
2017-01-19 17:58:39 +02:00
|
|
|
|
pid_t pid = -1;
|
|
|
|
|
bool separatePG = false;
|
|
|
|
|
int killSignal = SIGKILL;
|
2004-06-22 12:51:44 +03:00
|
|
|
|
public:
|
|
|
|
|
Pid();
|
2014-07-10 17:50:51 +03:00
|
|
|
|
Pid(pid_t pid);
|
2004-06-22 12:51:44 +03:00
|
|
|
|
~Pid();
|
|
|
|
|
void operator =(pid_t pid);
|
|
|
|
|
operator pid_t();
|
2017-03-16 11:52:28 +02:00
|
|
|
|
int kill();
|
2017-01-19 17:58:39 +02:00
|
|
|
|
int wait();
|
|
|
|
|
|
2004-06-22 12:51:44 +03:00
|
|
|
|
void setSeparatePG(bool separatePG);
|
2007-03-19 14:48:45 +02:00
|
|
|
|
void setKillSignal(int signal);
|
2016-10-12 16:49:37 +03:00
|
|
|
|
pid_t release();
|
2004-06-22 12:51:44 +03:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2006-12-07 02:16:07 +02:00
|
|
|
|
/* Kill all processes running under the specified uid by sending them
|
|
|
|
|
a SIGKILL. */
|
|
|
|
|
void killUser(uid_t uid);
|
|
|
|
|
|
|
|
|
|
|
2014-07-10 17:50:51 +03:00
|
|
|
|
/* Fork a process that runs the given function, and return the child
|
|
|
|
|
pid to the caller. */
|
2014-12-10 17:35:42 +02:00
|
|
|
|
struct ProcessOptions
|
|
|
|
|
{
|
2017-01-19 16:15:45 +02:00
|
|
|
|
string errorPrefix = "error: ";
|
|
|
|
|
bool dieWithParent = true;
|
|
|
|
|
bool runExitHandlers = false;
|
|
|
|
|
bool allowVfork = true;
|
2014-12-10 17:35:42 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
pid_t startProcess(std::function<void()> fun, const ProcessOptions & options = ProcessOptions());
|
2014-07-10 17:50:51 +03:00
|
|
|
|
|
|
|
|
|
|
2006-07-20 15:17:25 +03:00
|
|
|
|
/* Run a program and return its stdout in a string (i.e., like the
|
|
|
|
|
shell backtick operator). */
|
2007-02-21 16:31:42 +02:00
|
|
|
|
string runProgram(Path program, bool searchPath = false,
|
2017-03-15 15:40:47 +02:00
|
|
|
|
const Strings & args = Strings(),
|
|
|
|
|
const std::experimental::optional<std::string> & input = {});
|
2006-07-20 15:17:25 +03:00
|
|
|
|
|
2016-09-21 17:21:47 +03:00
|
|
|
|
class ExecError : public Error
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
int status;
|
|
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
|
ExecError(int status, Args... args)
|
|
|
|
|
: Error(args...), status(status)
|
|
|
|
|
{ }
|
|
|
|
|
};
|
2014-05-21 18:19:36 +03:00
|
|
|
|
|
2014-12-12 16:01:16 +02:00
|
|
|
|
/* Convert a list of strings to a null-terminated vector of char
|
|
|
|
|
*'s. The result must not be accessed beyond the lifetime of the
|
|
|
|
|
list of strings. */
|
2015-06-09 11:50:55 +03:00
|
|
|
|
std::vector<char *> stringsToCharPtrs(const Strings & ss);
|
2014-12-12 16:01:16 +02:00
|
|
|
|
|
2008-08-02 15:54:35 +03:00
|
|
|
|
/* Close all file descriptors except stdin, stdout, stderr, and those
|
|
|
|
|
listed in the given set. Good practice in child processes. */
|
|
|
|
|
void closeMostFDs(const set<int> & exceptions);
|
|
|
|
|
|
2012-03-05 21:29:00 +02:00
|
|
|
|
/* Set the close-on-exec flag for the given file descriptor. */
|
|
|
|
|
void closeOnExec(int fd);
|
|
|
|
|
|
2006-07-20 15:17:25 +03:00
|
|
|
|
|
2004-01-15 22:23:55 +02:00
|
|
|
|
/* User interruption. */
|
|
|
|
|
|
2017-01-17 19:21:02 +02:00
|
|
|
|
extern bool _isInterrupted;
|
2004-01-15 22:23:55 +02:00
|
|
|
|
|
2017-04-21 17:28:10 +03:00
|
|
|
|
void setInterruptThrown();
|
2016-03-29 16:08:24 +03:00
|
|
|
|
|
2004-01-15 22:23:55 +02:00
|
|
|
|
void _interrupted();
|
|
|
|
|
|
|
|
|
|
void inline checkInterrupt()
|
|
|
|
|
{
|
|
|
|
|
if (_isInterrupted) _interrupted();
|
|
|
|
|
}
|
|
|
|
|
|
2007-08-12 03:29:28 +03:00
|
|
|
|
MakeError(Interrupted, BaseError)
|
2006-12-04 19:17:13 +02:00
|
|
|
|
|
2004-01-15 22:23:55 +02:00
|
|
|
|
|
2016-07-19 01:50:27 +03:00
|
|
|
|
MakeError(FormatError, Error)
|
|
|
|
|
|
|
|
|
|
|
2005-09-22 18:43:22 +03:00
|
|
|
|
/* String tokenizer. */
|
2012-09-19 22:43:23 +03:00
|
|
|
|
template<class C> C tokenizeString(const string & s, const string & separators = " \t\n\r");
|
2005-09-22 18:43:22 +03:00
|
|
|
|
|
|
|
|
|
|
2010-08-27 16:18:13 +03:00
|
|
|
|
/* Concatenate the given strings with a separator between the
|
|
|
|
|
elements. */
|
|
|
|
|
string concatStringsSep(const string & sep, const Strings & ss);
|
2012-11-26 16:39:10 +02:00
|
|
|
|
string concatStringsSep(const string & sep, const StringSet & ss);
|
2010-08-27 16:18:13 +03:00
|
|
|
|
|
|
|
|
|
|
2012-08-01 18:19:24 +03:00
|
|
|
|
/* Remove trailing whitespace from a string. */
|
|
|
|
|
string chomp(const string & s);
|
|
|
|
|
|
|
|
|
|
|
2015-04-09 12:42:04 +03:00
|
|
|
|
/* Remove whitespace from the start and end of a string. */
|
|
|
|
|
string trim(const string & s, const string & whitespace = " \n\r\t");
|
|
|
|
|
|
|
|
|
|
|
2015-06-17 17:20:11 +03:00
|
|
|
|
/* Replace all occurrences of a string inside another string. */
|
|
|
|
|
string replaceStrings(const std::string & s,
|
|
|
|
|
const std::string & from, const std::string & to);
|
|
|
|
|
|
|
|
|
|
|
2004-06-22 11:50:25 +03:00
|
|
|
|
/* Convert the exit status of a child as returned by wait() into an
|
|
|
|
|
error string. */
|
|
|
|
|
string statusToString(int status);
|
|
|
|
|
|
2004-06-22 14:03:41 +03:00
|
|
|
|
bool statusOk(int status);
|
|
|
|
|
|
2004-06-22 11:50:25 +03:00
|
|
|
|
|
2004-09-10 16:32:08 +03:00
|
|
|
|
/* Parse a string into an integer. */
|
2009-11-24 14:26:25 +02:00
|
|
|
|
template<class N> bool string2Int(const string & s, N & n)
|
|
|
|
|
{
|
2016-01-19 14:00:02 +02:00
|
|
|
|
if (string(s, 0, 1) == "-" && !std::numeric_limits<N>::is_signed)
|
|
|
|
|
return false;
|
2009-11-24 14:26:25 +02:00
|
|
|
|
std::istringstream str(s);
|
|
|
|
|
str >> n;
|
|
|
|
|
return str && str.get() == EOF;
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-05 01:40:40 +02:00
|
|
|
|
/* Parse a string into a float. */
|
|
|
|
|
template<class N> bool string2Float(const string & s, N & n)
|
|
|
|
|
{
|
|
|
|
|
std::istringstream str(s);
|
|
|
|
|
str >> n;
|
|
|
|
|
return str && str.get() == EOF;
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-10 16:32:08 +03:00
|
|
|
|
|
2016-04-29 22:04:40 +03:00
|
|
|
|
/* Return true iff `s' starts with `prefix'. */
|
|
|
|
|
bool hasPrefix(const string & s, const string & prefix);
|
|
|
|
|
|
|
|
|
|
|
2008-08-25 16:31:57 +03:00
|
|
|
|
/* Return true iff `s' ends in `suffix'. */
|
|
|
|
|
bool hasSuffix(const string & s, const string & suffix);
|
|
|
|
|
|
|
|
|
|
|
2016-09-14 15:42:15 +03:00
|
|
|
|
/* Convert a string to lower case. */
|
|
|
|
|
std::string toLower(const std::string & s);
|
|
|
|
|
|
|
|
|
|
|
2012-09-29 04:39:30 +03:00
|
|
|
|
/* Escape a string that contains octal-encoded escape codes such as
|
|
|
|
|
used in /etc/fstab and /proc/mounts (e.g. "foo\040bar" decodes to
|
|
|
|
|
"foo bar"). */
|
|
|
|
|
string decodeOctalEscaped(const string & s);
|
|
|
|
|
|
|
|
|
|
|
2010-04-19 16:46:58 +03:00
|
|
|
|
/* Exception handling in destructors: print an error message, then
|
|
|
|
|
ignore the exception. */
|
|
|
|
|
void ignoreException();
|
2008-09-17 13:02:55 +03:00
|
|
|
|
|
|
|
|
|
|
2014-08-20 17:01:16 +03:00
|
|
|
|
/* Some ANSI escape sequences. */
|
|
|
|
|
#define ANSI_NORMAL "\e[0m"
|
|
|
|
|
#define ANSI_BOLD "\e[1m"
|
|
|
|
|
#define ANSI_RED "\e[31;1m"
|
|
|
|
|
|
|
|
|
|
|
2016-11-26 01:37:43 +02:00
|
|
|
|
/* Filter out ANSI escape codes from the given string. If ‘nixOnly’ is
|
2014-08-20 17:01:16 +03:00
|
|
|
|
set, only filter escape codes generated by Nixpkgs' stdenv (used to
|
|
|
|
|
denote nesting etc.). */
|
|
|
|
|
string filterANSIEscapes(const string & s, bool nixOnly = false);
|
|
|
|
|
|
|
|
|
|
|
2015-02-09 16:09:39 +02:00
|
|
|
|
/* Base64 encoding/decoding. */
|
|
|
|
|
string base64Encode(const string & s);
|
|
|
|
|
string base64Decode(const string & s);
|
|
|
|
|
|
|
|
|
|
|
Eliminate the "store" global variable
Also, move a few free-standing functions into StoreAPI and Derivation.
Also, introduce a non-nullable smart pointer, ref<T>, which is just a
wrapper around std::shared_ptr ensuring that the pointer is never
null. (For reference-counted values, this is better than passing a
"T&", because the latter doesn't maintain the refcount. Usually, the
caller will have a shared_ptr keeping the value alive, but that's not
always the case, e.g., when passing a reference to a std::thread via
std::bind.)
2016-02-04 15:28:26 +02:00
|
|
|
|
/* Get a value for the specified key from an associate container, or a
|
|
|
|
|
default value if the key doesn't exist. */
|
|
|
|
|
template <class T>
|
|
|
|
|
string get(const T & map, const string & key, const string & def = "")
|
|
|
|
|
{
|
|
|
|
|
auto i = map.find(key);
|
|
|
|
|
return i == map.end() ? def : i->second;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2016-11-26 01:37:43 +02:00
|
|
|
|
/* Call ‘failure’ with the current exception as argument. If ‘failure’
|
2016-09-16 19:54:14 +03:00
|
|
|
|
throws an exception, abort the program. */
|
2016-09-20 18:49:31 +03:00
|
|
|
|
void callFailure(const std::function<void(std::exception_ptr exc)> & failure,
|
|
|
|
|
std::exception_ptr exc = std::current_exception());
|
2016-09-16 19:54:14 +03:00
|
|
|
|
|
|
|
|
|
|
2016-11-26 01:37:43 +02:00
|
|
|
|
/* Evaluate the function ‘f’. If it returns a value, call ‘success’
|
|
|
|
|
with that value as its argument. If it or ‘success’ throws an
|
|
|
|
|
exception, call ‘failure’. If ‘failure’ throws an exception, abort
|
2016-09-16 19:54:14 +03:00
|
|
|
|
the program. */
|
|
|
|
|
template<class T>
|
|
|
|
|
void sync2async(
|
|
|
|
|
const std::function<void(T)> & success,
|
|
|
|
|
const std::function<void(std::exception_ptr exc)> & failure,
|
|
|
|
|
const std::function<T()> & f)
|
|
|
|
|
{
|
|
|
|
|
try {
|
|
|
|
|
success(f());
|
|
|
|
|
} catch (...) {
|
|
|
|
|
callFailure(failure);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2016-11-26 01:37:43 +02:00
|
|
|
|
/* Call the function ‘success’. If it throws an exception, call
|
|
|
|
|
‘failure’. If that throws an exception, abort the program. */
|
2016-09-16 19:54:14 +03:00
|
|
|
|
template<class T>
|
|
|
|
|
void callSuccess(
|
|
|
|
|
const std::function<void(T)> & success,
|
|
|
|
|
const std::function<void(std::exception_ptr exc)> & failure,
|
|
|
|
|
T && arg)
|
|
|
|
|
{
|
|
|
|
|
try {
|
|
|
|
|
success(arg);
|
|
|
|
|
} catch (...) {
|
|
|
|
|
callFailure(failure);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2017-01-17 19:21:02 +02:00
|
|
|
|
/* Start a thread that handles various signals. Also block those signals
|
|
|
|
|
on the current thread (and thus any threads created by it). */
|
|
|
|
|
void startSignalHandlerThread();
|
|
|
|
|
|
2017-02-01 14:00:21 +02:00
|
|
|
|
/* Restore default signal handling. */
|
|
|
|
|
void restoreSignals();
|
|
|
|
|
|
2017-01-17 19:21:02 +02:00
|
|
|
|
struct InterruptCallback
|
|
|
|
|
{
|
|
|
|
|
virtual ~InterruptCallback() { };
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* Register a function that gets called on SIGINT (in a non-signal
|
|
|
|
|
context). */
|
|
|
|
|
std::unique_ptr<InterruptCallback> createInterruptCallback(
|
|
|
|
|
std::function<void()> callback);
|
|
|
|
|
|
2017-01-25 14:37:02 +02:00
|
|
|
|
void triggerInterrupt();
|
|
|
|
|
|
|
|
|
|
/* A RAII class that causes the current thread to receive SIGUSR1 when
|
|
|
|
|
the signal handler thread receives SIGINT. That is, this allows
|
|
|
|
|
SIGINT to be multiplexed to multiple threads. */
|
|
|
|
|
struct ReceiveInterrupts
|
|
|
|
|
{
|
|
|
|
|
pthread_t target;
|
|
|
|
|
std::unique_ptr<InterruptCallback> callback;
|
|
|
|
|
|
|
|
|
|
ReceiveInterrupts()
|
|
|
|
|
: target(pthread_self())
|
|
|
|
|
, callback(createInterruptCallback([&]() { pthread_kill(target, SIGUSR1); }))
|
|
|
|
|
{ }
|
|
|
|
|
};
|
|
|
|
|
|
2006-09-05 00:06:23 +03:00
|
|
|
|
}
|