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
// Copyright 2016 Mozilla Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::errors::*;
use clap::{Arg, ArgAction, ArgGroup, ValueEnum, error::ErrorKind};
use std::env;
use std::ffi::OsString;
use std::path::PathBuf;
use std::str::FromStr;
use which::which_in;
const ENV_VAR_INTERNAL_START_SERVER: &str = "SCCACHE_START_SERVER";
#[derive(Debug, Clone, ValueEnum, Default)]
pub enum StatsFormat {
#[default]
Text,
Json,
}
impl StatsFormat {
fn as_str(&self) -> &'static str {
match self {
Self::Text => "text",
Self::Json => "json",
}
}
}
impl FromStr for StatsFormat {
type Err = anyhow::Error;
fn from_str(s: &str) -> anyhow::Result<Self> {
match s {
"text" => Ok(Self::Text),
"json" => Ok(Self::Json),
_ => bail!("Unrecognized stats format: {:?}", s),
}
}
}
/// A specific command to run.
pub enum Command {
/// Show cache statistics and exit.
ShowStats(StatsFormat, bool),
/// Run background server.
InternalStartServer,
/// Start background server as a subprocess.
StartServer,
/// Stop background server.
StopServer,
/// Zero cache statistics and exit.
ZeroStats,
/// Show the status of the distributed client.
DistStatus,
/// Perform a login to authenticate for distributed compilation.
DistAuth,
/// Package a toolchain for distributed compilation (executable, out)
PackageToolchain(PathBuf, PathBuf),
/// Run a compiler command.
Compile {
/// The binary to execute.
exe: OsString,
/// The commandline arguments to pass to `exe`.
cmdline: Vec<OsString>,
/// The directory in which to execute the command.
cwd: PathBuf,
/// The environment variables to use for execution.
env_vars: Vec<(OsString, OsString)>,
},
DebugPreprocessorCacheEntries,
}
fn flag_infer_long_and_short(name: &'static str) -> Arg {
flag_infer_long(name).short(name.chars().next().expect("Name needs at least one char"))
}
fn flag_infer_long(name: &'static str) -> Arg {
Arg::new(name).long(name)
}
/// Get the [`clap::Command`] used for argument parsing.
fn get_clap_command() -> clap::Command {
clap::Command::new(env!("CARGO_PKG_NAME"))
.version(env!("CARGO_PKG_VERSION"))
.max_term_width(110)
.after_help(concat!(
"Enabled features:\n",
" S3: ",
cfg!(feature = "s3"),
"\n",
" Redis: ",
cfg!(feature = "redis"),
"\n",
" Memcached: ",
cfg!(feature = "memcached"),
"\n",
" GCS: ",
cfg!(feature = "gcs"),
"\n",
" GHA: ",
cfg!(feature = "gha"),
"\n",
" Azure: ",
cfg!(feature = "azure"),
"\n",
" WebDAV: ",
cfg!(feature = "webdav"),
"\n",
" OSS: ",
cfg!(feature = "oss"),
"\n",
" COS: ",
cfg!(feature = "cos"),
"\n"
))
.args(&[
flag_infer_long_and_short("show-stats")
.help("show cache statistics")
.action(ArgAction::SetTrue),
flag_infer_long("show-adv-stats")
.help("show advanced cache statistics")
.action(ArgAction::SetTrue),
flag_infer_long("start-server")
.help("start background server")
.action(ArgAction::SetTrue),
flag_infer_long("debug-preprocessor-cache")
.help("show all preprocessor cache entries")
.action(ArgAction::SetTrue),
flag_infer_long("stop-server")
.help("stop background server")
.action(ArgAction::SetTrue),
flag_infer_long_and_short("zero-stats")
.help("zero statistics counters")
.action(ArgAction::SetTrue),
flag_infer_long("dist-auth")
.help("authenticate for distributed compilation")
.action(ArgAction::SetTrue),
flag_infer_long("dist-status")
.help("show status of the distributed client")
.action(ArgAction::SetTrue),
flag_infer_long("package-toolchain")
.help("package toolchain for distributed compilation")
.value_parser(clap::value_parser!(PathBuf))
.num_args(2)
.value_names(["EXE", "OUT"]),
flag_infer_long("stats-format")
.help("set output format of statistics")
.value_name("FMT")
.value_parser(clap::value_parser!(StatsFormat))
.default_value(StatsFormat::default().as_str()),
Arg::new("CMD")
.value_parser(clap::value_parser!(OsString))
.trailing_var_arg(true)
.action(ArgAction::Append),
])
.group(
ArgGroup::new("one_and_only_one")
.args([
"dist-auth",
"debug-preprocessor-cache",
"dist-status",
"show-stats",
"show-adv-stats",
"start-server",
"stop-server",
"zero-stats",
"package-toolchain",
"CMD",
])
.required(true),
)
}
/// Parse the commandline args into a `Result<Command>` to execute.
pub fn try_parse() -> Result<Command> {
trace!("parse");
let cwd =
env::current_dir().context("sccache: Couldn't determine current working directory")?;
// We only care if it's `1`
let internal_start_server = env::var(ENV_VAR_INTERNAL_START_SERVER).as_deref() == Ok("1");
let mut args: Vec<_> = env::args_os().collect();
if !internal_start_server {
// current_exe() follows symlinks on some OSes, so try argv[0] to get the original invocation
if let Ok(exe) = match env::args().next() {
Some(s) if !s.is_empty() => Ok(PathBuf::from(s)),
_ => env::current_exe(),
} {
match exe
.file_stem()
.and_then(|s| s.to_str())
.map(|s| s.to_lowercase())
{
// If the executable has its standard name, do nothing.
Some(ref e) if e == env!("CARGO_PKG_NAME") => {}
// Otherwise, if it was copied/linked under a different $name, act
// as if it were invoked with `sccache $name`, but avoid $name resolving
// to ourselves again if it's in the PATH.
_ => {
if let (Some(path), Some(exe_filename)) = (env::var_os("PATH"), exe.file_name())
{
match which_in(exe_filename, Some(&path), &cwd) {
Ok(ref full_path)
if full_path.canonicalize()?
== env::current_exe()?.canonicalize()? =>
{
if let Some(dir) = full_path.parent() {
let path = env::join_paths(
env::split_paths(&path).filter(|p| p != dir),
)
.ok();
if let Ok(full_path) = which_in(exe_filename, path, &cwd) {
args[0] = full_path.into();
}
}
}
Ok(full_path) => args[0] = full_path.into(),
Err(_) => {}
}
args.insert(0, env!("CARGO_PKG_NAME").into());
}
}
}
}
}
let matches_result = get_clap_command().try_get_matches_from(args);
// A command can either be from `ENV_VAR_INTERNAL_START_SERVER` being set or from command-line
// args. Validate things so that error messages are nice and the returned opts are correct
match (internal_start_server, matches_result) {
(true, Err(e)) => {
// Need to make sure that the error from `clap` is due to a missing command and not
// some other issue
if e.kind() == ErrorKind::MissingRequiredArgument {
Ok(Command::InternalStartServer)
} else {
Err(e.into())
}
}
(false, Err(e)) => Err(e.into()),
(true, Ok(_)) => {
// `ENV_VAR_INTERNAL_START_SERVER` and a match means that more than one command was
// provided
bail!("`{ENV_VAR_INTERNAL_START_SERVER}=1` can't be used with other commands");
}
(false, Ok(matches)) => {
if matches.get_flag("show-stats") {
let fmt = matches
.get_one("stats-format")
.cloned()
.expect("There is a default value");
Ok(Command::ShowStats(fmt, false))
} else if matches.get_flag("show-adv-stats") {
let fmt = matches
.get_one("stats-format")
.cloned()
.expect("There is a default value");
Ok(Command::ShowStats(fmt, true))
} else if matches.get_flag("start-server") {
Ok(Command::StartServer)
} else if matches.get_flag("debug-preprocessor-cache") {
Ok(Command::DebugPreprocessorCacheEntries)
} else if matches.get_flag("stop-server") {
Ok(Command::StopServer)
} else if matches.get_flag("zero-stats") {
Ok(Command::ZeroStats)
} else if matches.get_flag("dist-auth") {
Ok(Command::DistAuth)
} else if matches.get_flag("dist-status") {
Ok(Command::DistStatus)
} else if matches.contains_id("package-toolchain") {
let mut toolchain_values = matches
.get_many("package-toolchain")
.expect("`package-toolchain` requires two values")
.cloned()
.collect::<Vec<PathBuf>>();
let maybe_out = toolchain_values.pop();
let maybe_exe = toolchain_values.pop();
match (maybe_exe, maybe_out) {
(Some(exe), Some(out)) => Ok(Command::PackageToolchain(exe, out)),
_ => unreachable!("clap should enforce two values"),
}
} else if matches.contains_id("CMD") {
let mut env_vars = env::vars_os().collect::<Vec<_>>();
// If we're running under rr, avoid the `LD_PRELOAD` bits, as it will
// almost surely do the wrong thing, as the compiler gets executed
// in a different process tree.
env_vars.retain(|(k, _v)| {
k != "LD_PRELOAD"
&& k != "RUNNING_UNDER_RR"
&& k != "HOSTNAME"
&& k != "PWD"
&& k != "HOST"
&& k != "RPM_BUILD_ROOT"
&& k != "SOURCE_DATE_EPOCH"
&& k != "RPM_PACKAGE_RELEASE"
&& k != "MINICOM"
&& k != "DESTDIR"
&& k != "RPM_PACKAGE_VERSION"
&& k != "CARGO_MAKEFLAGS"
});
let cmd = matches
.get_many("CMD")
.expect("CMD is required")
.cloned()
.collect::<Vec<OsString>>();
match cmd.as_slice() {
[exe, cmdline @ ..] => Ok(Command::Compile {
exe: exe.to_owned(),
cmdline: cmdline.to_owned(),
cwd,
env_vars,
}),
_ => unreachable!("clap should enforce at least one value in cmd"),
}
} else {
unreachable!("Either the arg group or env variable should provide a command");
}
}
}
}