File: llvm-remote-cache-test.cpp

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (139 lines) | stat: -rw-r--r-- 4,862 bytes parent folder | download
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
//===-- llvm-remote-cache-test.cpp - Remote Cache Service -----------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// A server for of the remote cache service protocol, for testing purposes.
//
//===----------------------------------------------------------------------===//

#include "llvm/CAS/ActionCache.h"
#include "llvm/CAS/BuiltinUnifiedCASDatabases.h"
#include "llvm/CAS/ObjectStore.h"
#include "llvm/RemoteCachingService/LLVMCASCacheProvider.h"
#include "llvm/RemoteCachingService/RemoteCacheProvider.h"
#include "llvm/RemoteCachingService/RemoteCacheServer.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/Program.h"
#include "llvm/Support/raw_ostream.h"
#include <thread>

#ifdef _WIN32
#define setenv(name, var, ignore) _putenv_s(name, var)
#endif

using namespace llvm;
using namespace llvm::cas;

int main(int Argc, const char **Argv) {
  InitLLVM X(Argc, Argv);

  cl::OptionCategory OptCategory("llvm-remote-cache-test options");
  cl::extrahelp MoreHelp(
      "\n"
      "Implements the remote caching gRPC protocol with an on-disk LLVMCAS as "
      "the caching backend.\n"
      "Supports two modes of operation:\n"
      "  * Start and run continuously as a server, or\n"
      "  * Start and run the given command, after setting the "
      "LLVM_CACHE_REMOTE_SERVICE_SOCKET_PATH environment variable.\n"
      "    It exits with the same exit code as the command."
      "\n");

  cl::opt<std::string> CachePath("cache-path", cl::desc("Cache data path"),
                                 cl::Required, cl::value_desc("path"),
                                 cl::cat(OptCategory));
  cl::opt<std::string> OptSocketPath(
      "socket-path", cl::desc("Socket path (default is '<cache-path>/sock')"),
      cl::value_desc("path"), cl::cat(OptCategory));
  // This is here only to improve the help message (for "USAGE:" line).
  cl::list<std::string> Inputs(cl::Positional, cl::desc("[-- command ...]"));

  auto Sep = std::find_if(Argv + 1, Argv + Argc, [](const char *Arg) {
    return StringRef(Arg) == "--";
  });
  bool ServerMode = Sep == Argv + Argc;

  cl::HideUnrelatedOptions(OptCategory);
  cl::ParseCommandLineOptions(Sep - Argv, Argv, "llvm-remote-cache-test");

  SmallString<128> SocketPath{OptSocketPath};
  if (SocketPath.empty()) {
    SocketPath = CachePath;
    sys::path::append(SocketPath, "sock");
  }

  static ExitOnError ExitOnErr("llvm-remote-cache-test: ");

  SmallString<256> TempPath(CachePath);
  sys::path::append(TempPath, "tmp");
  if (std::error_code EC = sys::fs::create_directories(TempPath))
    ExitOnErr(errorCodeToError(EC));

  SmallString<256> CASPath(CachePath);
  sys::path::append(CASPath, "cas");
  std::unique_ptr<ObjectStore> CAS;
  std::unique_ptr<ActionCache> AC;
  std::tie(CAS, AC) = ExitOnErr(createOnDiskUnifiedCASDatabases(CASPath));

  auto createServer = [&]() -> remote::RemoteCacheServer {
    return remote::RemoteCacheServer(
        SocketPath, remote::createLLVMCASCacheProvider(TempPath, std::move(CAS),
                                                       std::move(AC)));
  };

  if (ServerMode) {
    outs() << "Server listening on " << SocketPath << '\n';
    remote::RemoteCacheServer Server = createServer();
    Server.Start();
    Server.Listen();
    return 0;
  }

  SmallVector<const char *, 256> CmdArgs(Sep + 1, Argv + Argc);
  if (CmdArgs.empty()) {
    // No command arguments.
    cl::PrintHelpMessage();
    return 1;
  }

  ErrorOr<std::string> ExecPathOrErr = sys::findProgramByName(CmdArgs.front());
  if (!ExecPathOrErr) {
    errs() << "error: cannot find executable " << CmdArgs.front() << '\n';
    return 1;
  }
  std::string ExecPath = std::move(*ExecPathOrErr);
  CmdArgs[0] = ExecPath.c_str();

  SmallVector<StringRef, 32> RefArgs;
  RefArgs.reserve(CmdArgs.size());
  for (const char *Arg : CmdArgs) {
    RefArgs.push_back(Arg);
  }

  remote::RemoteCacheServer Server = createServer();
  // Make sure to start the server before executing the command.
  Server.Start();
  std::thread ServerThread([&Server]() { Server.Listen(); });

  setenv("LLVM_CACHE_REMOTE_SERVICE_SOCKET_PATH", SocketPath.c_str(), true);

  std::string ErrMsg;
  int Result =
      sys::ExecuteAndWait(RefArgs.front(), RefArgs, /*Env*/ std::nullopt,
                          /*Redirects*/ {}, /*SecondsToWait*/ 0,
                          /*MemoryLimit*/ 0, &ErrMsg);
  if (!ErrMsg.empty()) {
    errs() << "error: failed executing command: " << ErrMsg << '\n';
  }

  Server.Shutdown();
  ServerThread.join();

  return Result;
}