about summary refs log tree commit diff
path: root/third_party/nix/src/libmain/shared.cc
blob: 549134872e91d13c76430b722bbc3f1a806fd18a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
#include "shared.hh"

#include <algorithm>
#include <cctype>
#include <csignal>
#include <cstdlib>
#include <exception>
#include <iostream>
#include <mutex>
#include <utility>

#include <glog/logging.h>
#include <openssl/crypto.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <unistd.h>

#include "globals.hh"
#include "store-api.hh"
#include "util.hh"

namespace nix {

static bool gcWarning = true;

void printGCWarning() {
  if (!gcWarning) {
    return;
  }

  static bool haveWarned = false;
  if (!haveWarned) {
    haveWarned = true;
    LOG(WARNING) << "you did not specify '--add-root'; "
                 << "the result might be removed by the garbage collector";
  }
}

void printMissing(const ref<Store>& store, const PathSet& paths) {
  unsigned long long downloadSize;
  unsigned long long narSize;
  PathSet willBuild;
  PathSet willSubstitute;
  PathSet unknown;
  store->queryMissing(paths, willBuild, willSubstitute, unknown, downloadSize,
                      narSize);
  printMissing(store, willBuild, willSubstitute, unknown, downloadSize,
               narSize);
}

void printMissing(const ref<Store>& store, const PathSet& willBuild,
                  const PathSet& willSubstitute, const PathSet& unknown,
                  unsigned long long downloadSize, unsigned long long narSize) {
  if (!willBuild.empty()) {
    LOG(INFO) << "these derivations will be built:";
    Paths sorted = store->topoSortPaths(willBuild);
    reverse(sorted.begin(), sorted.end());
    for (auto& i : sorted) {
      LOG(INFO) << "  " << i;
    }
  }

  if (!willSubstitute.empty()) {
    LOG(INFO) << "these paths will be fetched ("
              << (downloadSize / (1024.0 * 1024.0)) << " MiB download, "
              << (narSize / (1024.0 * 1024.0)) << "MiB unpacked):";

    for (auto& i : willSubstitute) {
      LOG(INFO) << i;
    }
  }

  if (!unknown.empty()) {
    LOG(INFO) << "don't know how to build these paths"
              << (settings.readOnlyMode
                      ? " (may be caused by read-only store access)"
                      : "")
              << ":";

    for (auto& i : unknown) {
      LOG(INFO) << i;
    }
  }
}

std::string getArg(const std::string& opt, Strings::iterator& i,
                   const Strings::iterator& end) {
  ++i;
  if (i == end) {
    throw UsageError(format("'%1%' requires an argument") % opt);
  }

  return *i;
}

#if OPENSSL_VERSION_NUMBER < 0x10101000L
/* OpenSSL is not thread-safe by default - it will randomly crash
   unless the user supplies a mutex locking function. So let's do
   that. */
static std::vector<std::mutex> opensslLocks;

static void opensslLockCallback(int mode, int type, const char* file,
                                int line) {
  if (mode & CRYPTO_LOCK)
    opensslLocks[type].lock();
  else
    opensslLocks[type].unlock();
}
#endif

static void sigHandler(int signo) {}

void initNix() {
  /* Turn on buffering for cerr. */
#if HAVE_PUBSETBUF
  static char buf[1024];
  std::cerr.rdbuf()->pubsetbuf(buf, sizeof(buf));
#endif

#if OPENSSL_VERSION_NUMBER < 0x10101000L
  /* Initialise OpenSSL locking. */
  opensslLocks = std::vector<std::mutex>(CRYPTO_num_locks());
  CRYPTO_set_locking_callback(opensslLockCallback);
#endif

  loadConfFile();

  startSignalHandlerThread();

  /* Reset SIGCHLD to its default. */
  struct sigaction act;
  sigemptyset(&act.sa_mask);
  act.sa_handler = SIG_DFL;
  act.sa_flags = 0;
  if (sigaction(SIGCHLD, &act, nullptr) != 0) {
    throw SysError("resetting SIGCHLD");
  }

  /* Install a dummy SIGUSR1 handler for use with pthread_kill(). */
  act.sa_handler = sigHandler;
  if (sigaction(SIGUSR1, &act, nullptr) != 0) {
    throw SysError("handling SIGUSR1");
  }

  /* Register a SIGSEGV handler to detect stack overflows. */
  detectStackOverflow();

  /* There is no privacy in the Nix system ;-)  At least not for
     now.  In particular, store objects should be readable by
     everybody. */
  umask(0022);

  /* Initialise the PRNG. */
  struct timeval tv;
  gettimeofday(&tv, nullptr);
  srandom(tv.tv_usec);
}

LegacyArgs::LegacyArgs(
    const std::string& programName,
    std::function<bool(Strings::iterator& arg, const Strings::iterator& end)>
        parseArg)
    : MixCommonArgs(programName), parseArg(std::move(parseArg)) {
  mkFlag()
      .longName("no-build-output")
      .shortName('Q')
      .description("do not show build output")
      .set(&settings.verboseBuild, false);

  mkFlag()
      .longName("keep-failed")
      .shortName('K')
      .description("keep temporary directories of failed builds")
      .set(&(bool&)settings.keepFailed, true);

  mkFlag()
      .longName("keep-going")
      .shortName('k')
      .description("keep going after a build fails")
      .set(&(bool&)settings.keepGoing, true);

  mkFlag()
      .longName("fallback")
      .description("build from source if substitution fails")
      .set(&(bool&)settings.tryFallback, true);

  auto intSettingAlias = [&](char shortName, const std::string& longName,
                             const std::string& description,
                             const std::string& dest) {
    mkFlag<unsigned int>(shortName, longName, description, [=](unsigned int n) {
      settings.set(dest, std::to_string(n));
    });
  };

  intSettingAlias(0, "cores",
                  "maximum number of CPU cores to use inside a build", "cores");
  intSettingAlias(0, "max-silent-time",
                  "number of seconds of silence before a build is killed",
                  "max-silent-time");
  intSettingAlias(0, "timeout", "number of seconds before a build is killed",
                  "timeout");

  mkFlag(0, "readonly-mode", "do not write to the Nix store",
         &settings.readOnlyMode);

  mkFlag(0, "no-gc-warning", "disable warning about not using '--add-root'",
         &gcWarning, false);

  mkFlag()
      .longName("store")
      .label("store-uri")
      .description("URI of the Nix store to use")
      .dest(&(std::string&)settings.storeUri);
}

bool LegacyArgs::processFlag(Strings::iterator& pos, Strings::iterator end) {
  if (MixCommonArgs::processFlag(pos, end)) {
    return true;
  }
  bool res = parseArg(pos, end);
  if (res) {
    ++pos;
  }
  return res;
}

bool LegacyArgs::processArgs(const Strings& args, bool finish) {
  if (args.empty()) {
    return true;
  }
  assert(args.size() == 1);
  Strings ss(args);
  auto pos = ss.begin();
  if (!parseArg(pos, ss.end())) {
    throw UsageError(format("unexpected argument '%1%'") % args.front());
  }
  return true;
}

void parseCmdLine(
    int argc, char** argv,
    std::function<bool(Strings::iterator& arg, const Strings::iterator& end)>
        parseArg) {
  parseCmdLine(baseNameOf(argv[0]), argvToStrings(argc, argv),
               std::move(parseArg));
}

void parseCmdLine(
    const std::string& programName, const Strings& args,
    std::function<bool(Strings::iterator& arg, const Strings::iterator& end)>
        parseArg) {
  LegacyArgs(programName, std::move(parseArg)).parseCmdline(args);
}

void printVersion(const std::string& programName) {
  std::cout << format("%1% (Nix) %2%") % programName % nixVersion << std::endl;

  // TODO(tazjin): figure out what the fuck this is
  /*if (verbosity > lvlInfo) {
    Strings cfg;
#if HAVE_BOEHMGC
    cfg.push_back("gc");
#endif
#if HAVE_SODIUM
    cfg.push_back("signed-caches");
#endif
    std::cout << "Features: " << concatStringsSep(", ", cfg) << "\n";
    std::cout << "Configuration file: " << settings.nixConfDir + "/nix.conf"
              << "\n";
    std::cout << "Store directory: " << settings.nixStore << "\n";
    std::cout << "State directory: " << settings.nixStateDir << "\n";
    } */
  throw Exit();
}

void showManPage(const std::string& name) {
  restoreSignals();
  setenv("MANPATH", settings.nixManDir.c_str(), 1);
  execlp("man", "man", name.c_str(), nullptr);
  throw SysError(format("command 'man %1%' failed") % name.c_str());
}

int handleExceptions(const std::string& programName,
                     const std::function<void()>& fun) {
  ReceiveInterrupts receiveInterrupts;  // FIXME: need better place for this

  std::string error = ANSI_RED "error:" ANSI_NORMAL " ";
  try {
    try {
      fun();
    } catch (...) {
      /* Subtle: we have to make sure that any `interrupted'
         condition is discharged before we reach printMsg()
         below, since otherwise it will throw an (uncaught)
         exception. */
      setInterruptThrown();
      throw;
    }
  } catch (Exit& e) {
    return e.status;
  } catch (UsageError& e) {
    LOG(INFO) << e.what();
    LOG(INFO) << "Try '" << programName << " "
              << " --help' for more information.";
    return 1;
  } catch (BaseError& e) {
    LOG(ERROR) << error << (settings.showTrace ? e.prefix() : "") << e.msg();
    if (!e.prefix().empty() && !settings.showTrace) {
      LOG(INFO) << "(use '--show-trace' to show detailed location information)";
    }
    return e.status;
  } catch (std::bad_alloc& e) {
    LOG(ERROR) << error << "failed to allocate: " << e.what();
    return 1;
  } catch (std::exception& e) {
    LOG(ERROR) << error << e.what();
    return 1;
  }

  return 0;
}

RunPager::RunPager() {
  if (isatty(STDOUT_FILENO) == 0) {
    return;
  }
  char* pager = getenv("NIX_PAGER");
  if (pager == nullptr) {
    pager = getenv("PAGER");
  }
  if (pager && ((std::string)pager == "" || (std::string)pager == "cat")) {
    return;
  }

  Pipe toPager;
  toPager.create();

  pid = startProcess([&]() {
    if (dup2(toPager.readSide.get(), STDIN_FILENO) == -1) {
      throw SysError("dupping stdin");
    }
    if (getenv("LESS") == nullptr) {
      setenv("LESS", "FRSXMK", 1);
    }
    restoreSignals();
    if (pager != nullptr) {
      execl("/bin/sh", "sh", "-c", pager, nullptr);
    }
    execlp("pager", "pager", nullptr);
    execlp("less", "less", nullptr);
    execlp("more", "more", nullptr);
    throw SysError(format("executing '%1%'") % pager);
  });

  pid.setKillSignal(SIGINT);

  if (dup2(toPager.writeSide.get(), STDOUT_FILENO) == -1) {
    throw SysError("dupping stdout");
  }
}

RunPager::~RunPager() {
  try {
    if (pid != -1) {
      std::cout.flush();
      close(STDOUT_FILENO);
      pid.wait();
    }
  } catch (...) {
    ignoreException();
  }
}

std::string showBytes(unsigned long long bytes) {
  return (format("%.2f MiB") % (bytes / (1024.0 * 1024.0))).str();
}

PrintFreed::~PrintFreed() {
  if (show) {
    std::cout << format("%1% store paths deleted, %2% freed\n") %
                     results.paths.size() % showBytes(results.bytesFreed);
  }
}

Exit::~Exit() = default;

}  // namespace nix