-
Notifications
You must be signed in to change notification settings - Fork 884
/
dist.rs
1248 lines (1125 loc) · 44.5 KB
/
dist.rs
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::collections::HashSet;
use std::env;
use std::fmt;
use std::io::Write;
use std::ops::Deref;
use std::path::Path;
use std::str::FromStr;
use anyhow::{anyhow, bail, Context, Result};
use chrono::NaiveDate;
use lazy_static::lazy_static;
use regex::Regex;
use thiserror::Error as ThisError;
pub(crate) use crate::dist::triple::*;
use crate::{
currentprocess::varsource::VarSource,
dist::{
download::DownloadCfg,
manifest::{Component, Manifest as ManifestV2},
manifestation::{Changes, Manifestation, UpdateStatus},
notifications::*,
prefix::InstallPrefix,
temp,
},
errors::RustupError,
process,
toolchain::names::ToolchainName,
utils::utils,
};
pub static DEFAULT_DIST_SERVER: &str = "https://static.rust-lang.org";
// Deprecated
pub(crate) static DEFAULT_DIST_ROOT: &str = "https://static.rust-lang.org/dist";
// The channel patterns we support
static TOOLCHAIN_CHANNELS: &[&str] = &[
"nightly",
"beta",
"stable",
// Allow from 1.0.0 through to 9.999.99 with optional patch version
r"\d{1}\.\d{1,3}(?:\.\d{1,2})?",
];
fn components_missing_msg(cs: &[Component], manifest: &ManifestV2, toolchain: &str) -> String {
assert!(!cs.is_empty());
let mut buf = vec![];
let suggestion = format!(" rustup toolchain add {toolchain} --profile minimal");
let nightly_tips = "Sometimes not all components are available in any given nightly. ";
if cs.len() == 1 {
let _ = writeln!(
buf,
"component {} is unavailable for download for channel '{}'",
&cs[0].description(manifest),
toolchain,
);
if toolchain.starts_with("nightly") {
let _ = write!(buf, "{nightly_tips}");
}
let _ = write!(
buf,
"If you don't need the component, you could try a minimal installation with:\n\n{suggestion}"
);
} else {
let cs_str = cs
.iter()
.map(|c| c.description(manifest))
.collect::<Vec<_>>()
.join(", ");
let _ = write!(
buf,
"some components unavailable for download for channel '{toolchain}': {cs_str}"
);
if toolchain.starts_with("nightly") {
let _ = write!(buf, "{nightly_tips}");
}
let _ = write!(
buf,
"If you don't need the components, you could try a minimal installation with:\n\n{suggestion}"
);
}
String::from_utf8(buf).unwrap()
}
#[derive(Debug, ThisError)]
pub(crate) enum DistError {
#[error("{}", components_missing_msg(.0, .1, .2))]
ToolchainComponentsMissing(Vec<Component>, Box<ManifestV2>, String),
#[error("no release found for '{0}'")]
MissingReleaseForToolchain(String),
#[error("invalid toolchain name: '{0}'")]
InvalidOfficialName(String),
}
#[derive(Debug, PartialEq)]
struct ParsedToolchainDesc {
channel: String,
date: Option<String>,
target: Option<String>,
}
// A toolchain descriptor from rustup's perspective. These contain
// 'partial target triples', which allow toolchain names like
// 'stable-msvc' to work. Partial target triples though are parsed
// from a hardcoded set of known triples, whereas target triples
// are nearly-arbitrary strings.
#[derive(Debug, Clone, Eq, PartialEq, PartialOrd, Ord)]
pub struct PartialToolchainDesc {
// Either "nightly", "stable", "beta", or an explicit version number
pub channel: String,
pub date: Option<String>,
pub target: PartialTargetTriple,
}
// Fully-resolved toolchain descriptors. These always have full target
// triples attached to them and are used for canonical identification,
// such as naming their installation directory.
//
// as strings they look like stable-x86_64-pc-windows-msvc or
/// 1.55-x86_64-pc-windows-msvc
#[derive(Debug, Clone, Eq, PartialEq, PartialOrd, Ord)]
pub struct ToolchainDesc {
// Either "nightly", "stable", "beta", or an explicit version number
pub channel: String,
pub date: Option<String>,
pub target: TargetTriple,
}
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct TargetTriple(String);
// Linux hosts don't indicate clib in uname, however binaries only
// run on boxes with the same clib, as expected.
#[cfg(all(not(windows), not(target_env = "musl")))]
const TRIPLE_X86_64_UNKNOWN_LINUX: &str = "x86_64-unknown-linux-gnu";
#[cfg(all(not(windows), target_env = "musl"))]
const TRIPLE_X86_64_UNKNOWN_LINUX: &str = "x86_64-unknown-linux-musl";
#[cfg(all(not(windows), not(target_env = "musl")))]
const TRIPLE_AARCH64_UNKNOWN_LINUX: &str = "aarch64-unknown-linux-gnu";
#[cfg(all(not(windows), target_env = "musl"))]
const TRIPLE_AARCH64_UNKNOWN_LINUX: &str = "aarch64-unknown-linux-musl";
// MIPS platforms don't indicate endianness in uname, however binaries only
// run on boxes with the same endianness, as expected.
// Hence we could distinguish between the variants with compile-time cfg()
// attributes alone.
#[cfg(all(not(windows), target_endian = "big"))]
static TRIPLE_MIPS_UNKNOWN_LINUX_GNU: &str = "mips-unknown-linux-gnu";
#[cfg(all(not(windows), target_endian = "little"))]
static TRIPLE_MIPS_UNKNOWN_LINUX_GNU: &str = "mipsel-unknown-linux-gnu";
#[cfg(all(not(windows), target_endian = "big"))]
static TRIPLE_MIPS64_UNKNOWN_LINUX_GNUABI64: &str = "mips64-unknown-linux-gnuabi64";
#[cfg(all(not(windows), target_endian = "little"))]
static TRIPLE_MIPS64_UNKNOWN_LINUX_GNUABI64: &str = "mips64el-unknown-linux-gnuabi64";
impl FromStr for ParsedToolchainDesc {
type Err = anyhow::Error;
fn from_str(desc: &str) -> Result<Self> {
lazy_static! {
static ref TOOLCHAIN_CHANNEL_PATTERN: String = format!(
r"^({})(?:-(\d{{4}}-\d{{2}}-\d{{2}}))?(?:-(.+))?$",
TOOLCHAIN_CHANNELS.join("|")
);
// Note this regex gives you a guaranteed match of the channel (1)
// and an optional match of the date (2) and target (3)
static ref TOOLCHAIN_CHANNEL_RE: Regex = Regex::new(&TOOLCHAIN_CHANNEL_PATTERN).unwrap();
}
let d = TOOLCHAIN_CHANNEL_RE.captures(desc).map(|c| {
fn fn_map(s: &str) -> Option<String> {
if s.is_empty() {
None
} else {
Some(s.to_owned())
}
}
// These versions don't have v2 manifests, but they don't have point releases either,
// so to make the two-part version numbers work for these versions, specially turn
// them into their corresponding ".0" version.
let channel = match c.get(1).unwrap().as_str() {
"1.0" => "1.0.0",
"1.1" => "1.1.0",
"1.2" => "1.2.0",
"1.3" => "1.3.0",
"1.4" => "1.4.0",
"1.5" => "1.5.0",
"1.6" => "1.6.0",
"1.7" => "1.7.0",
"1.8" => "1.8.0",
other => other,
};
Self {
channel: channel.to_owned(),
date: c.get(2).map(|s| s.as_str()).and_then(fn_map),
target: c.get(3).map(|s| s.as_str()).and_then(fn_map),
}
});
if let Some(d) = d {
Ok(d)
} else {
Err(RustupError::InvalidToolchainName(desc.to_string()).into())
}
}
}
impl Deref for TargetTriple {
type Target = str;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl TargetTriple {
pub fn new(name: &str) -> Self {
Self(name.to_string())
}
pub(crate) fn from_build() -> Self {
if let Some(triple) = option_env!("RUSTUP_OVERRIDE_BUILD_TRIPLE") {
Self::new(triple)
} else {
Self::new(env!("TARGET"))
}
}
pub(crate) fn from_host() -> Option<Self> {
#[cfg(windows)]
fn inner() -> Option<TargetTriple> {
use std::mem;
/// Get the host architecture using `IsWow64Process2`. This function
/// produces the most accurate results (supports detecting aarch64), but
/// it is only available on Windows 10 1511+, so we use `GetProcAddress`
/// to maintain backward compatibility with older Windows versions.
fn arch_primary() -> Option<&'static str> {
use winapi::shared::minwindef::BOOL;
use winapi::um::libloaderapi::{GetModuleHandleA, GetProcAddress};
use winapi::um::processthreadsapi::GetCurrentProcess;
use winapi::um::winnt::HANDLE;
const IMAGE_FILE_MACHINE_ARM64: u16 = 0xAA64;
const IMAGE_FILE_MACHINE_AMD64: u16 = 0x8664;
const IMAGE_FILE_MACHINE_I386: u16 = 0x014c;
#[allow(non_snake_case)]
let IsWow64Process2: unsafe extern "system" fn(
HANDLE,
*mut u16,
*mut u16,
)
-> BOOL = unsafe {
let module = GetModuleHandleA(b"kernel32.dll\0" as *const u8 as *const i8);
if module.is_null() {
return None;
}
let process =
GetProcAddress(module, b"IsWow64Process2\0" as *const u8 as *const i8);
if process.is_null() {
return None;
}
mem::transmute(process)
};
let mut _machine = 0;
let mut native_machine = 0;
unsafe {
// cannot fail; handle does not need to be closed.
let process = GetCurrentProcess();
if IsWow64Process2(process, &mut _machine, &mut native_machine) == 0 {
return None;
}
};
match native_machine {
IMAGE_FILE_MACHINE_AMD64 => Some("x86_64"),
IMAGE_FILE_MACHINE_I386 => Some("i686"),
IMAGE_FILE_MACHINE_ARM64 => Some("aarch64"),
_ => None,
}
}
/// Get the host architecture using `GetNativeSystemInfo`.
/// Does not support detecting aarch64.
fn arch_fallback() -> Option<&'static str> {
use winapi::um::sysinfoapi::GetNativeSystemInfo;
const PROCESSOR_ARCHITECTURE_AMD64: u16 = 9;
const PROCESSOR_ARCHITECTURE_INTEL: u16 = 0;
let mut sys_info;
unsafe {
sys_info = mem::zeroed();
GetNativeSystemInfo(&mut sys_info);
}
match unsafe { sys_info.u.s() }.wProcessorArchitecture {
PROCESSOR_ARCHITECTURE_AMD64 => Some("x86_64"),
PROCESSOR_ARCHITECTURE_INTEL => Some("i686"),
_ => None,
}
}
// Default to msvc
let arch = arch_primary().or_else(arch_fallback)?;
let msvc_triple = format!("{arch}-pc-windows-msvc");
Some(TargetTriple(msvc_triple))
}
#[cfg(not(windows))]
fn inner() -> Option<TargetTriple> {
use std::ffi::CStr;
use std::mem;
let mut sys_info;
let (sysname, machine) = unsafe {
sys_info = mem::zeroed();
if libc::uname(&mut sys_info) != 0 {
return None;
}
(
CStr::from_ptr(sys_info.sysname.as_ptr()).to_bytes(),
CStr::from_ptr(sys_info.machine.as_ptr()).to_bytes(),
)
};
let host_triple = match (sysname, machine) {
(_, b"arm") if cfg!(target_os = "android") => Some("arm-linux-androideabi"),
(_, b"armv7l") if cfg!(target_os = "android") => Some("armv7-linux-androideabi"),
(_, b"armv8l") if cfg!(target_os = "android") => Some("armv7-linux-androideabi"),
(_, b"aarch64") if cfg!(target_os = "android") => Some("aarch64-linux-android"),
(_, b"i686") if cfg!(target_os = "android") => Some("i686-linux-android"),
(_, b"x86_64") if cfg!(target_os = "android") => Some("x86_64-linux-android"),
(b"Linux", b"x86_64") => Some(TRIPLE_X86_64_UNKNOWN_LINUX),
(b"Linux", b"i686") => Some("i686-unknown-linux-gnu"),
(b"Linux", b"mips") => Some(TRIPLE_MIPS_UNKNOWN_LINUX_GNU),
(b"Linux", b"mips64") => Some(TRIPLE_MIPS64_UNKNOWN_LINUX_GNUABI64),
(b"Linux", b"arm") => Some("arm-unknown-linux-gnueabi"),
(b"Linux", b"armv7l") => Some("armv7-unknown-linux-gnueabihf"),
(b"Linux", b"armv8l") => Some("armv7-unknown-linux-gnueabihf"),
(b"Linux", b"aarch64") => Some(TRIPLE_AARCH64_UNKNOWN_LINUX),
(b"Darwin", b"x86_64") => Some("x86_64-apple-darwin"),
(b"Darwin", b"i686") => Some("i686-apple-darwin"),
(b"FreeBSD", b"x86_64") => Some("x86_64-unknown-freebsd"),
(b"FreeBSD", b"i686") => Some("i686-unknown-freebsd"),
(b"OpenBSD", b"x86_64") => Some("x86_64-unknown-openbsd"),
(b"OpenBSD", b"i686") => Some("i686-unknown-openbsd"),
(b"NetBSD", b"x86_64") => Some("x86_64-unknown-netbsd"),
(b"NetBSD", b"i686") => Some("i686-unknown-netbsd"),
(b"DragonFly", b"x86_64") => Some("x86_64-unknown-dragonfly"),
(b"SunOS", b"i86pc") => Some("x86_64-unknown-illumos"),
_ => None,
};
host_triple.map(TargetTriple::new)
}
if let Ok(triple) = process().var("RUSTUP_OVERRIDE_HOST_TRIPLE") {
Some(Self(triple))
} else {
inner()
}
}
pub(crate) fn from_host_or_build() -> Self {
Self::from_host().unwrap_or_else(Self::from_build)
}
pub(crate) fn can_run(&self, other: &TargetTriple) -> Result<bool> {
// Most trivial shortcut of all
if self == other {
return Ok(true);
}
// Otherwise we need to parse things
let partial_self = PartialTargetTriple::new(&self.0)
.ok_or_else(|| anyhow!(format!("Unable to parse target triple: {}", self.0)))?;
let partial_other = PartialTargetTriple::new(&other.0)
.ok_or_else(|| anyhow!(format!("Unable to parse target triple: {}", other.0)))?;
// First obvious check is OS, if that doesn't match there's no chance
let ret = if partial_self.os != partial_other.os {
false
} else if partial_self.os.as_deref() == Some("pc-windows") {
// Windows is a special case here: we can run gnu and msvc on the same system,
// x86_64 can run i686, and aarch64 can run i686 through emulation
(partial_self.arch == partial_other.arch)
|| (partial_self.arch.as_deref() == Some("x86_64")
&& partial_other.arch.as_deref() == Some("i686"))
|| (partial_self.arch.as_deref() == Some("aarch64")
&& partial_other.arch.as_deref() == Some("i686"))
} else {
// For other OSes, for now, we assume other toolchains won't run
false
};
Ok(ret)
}
}
impl std::convert::TryFrom<PartialTargetTriple> for TargetTriple {
type Error = &'static str;
fn try_from(value: PartialTargetTriple) -> std::result::Result<Self, Self::Error> {
if value.arch.is_some() && value.os.is_some() && value.env.is_some() {
Ok(Self(format!(
"{}-{}-{}",
value.arch.unwrap(),
value.os.unwrap(),
value.env.unwrap()
)))
} else {
Err("Incomplete / bad target triple")
}
}
}
impl FromStr for PartialToolchainDesc {
type Err = anyhow::Error;
fn from_str(name: &str) -> Result<Self> {
let parsed: ParsedToolchainDesc = name.parse()?;
let target = PartialTargetTriple::new(parsed.target.as_deref().unwrap_or(""));
target
.map(|target| Self {
channel: parsed.channel,
date: parsed.date,
target,
})
.ok_or_else(|| anyhow!(RustupError::InvalidToolchainName(name.to_string())))
}
}
impl PartialToolchainDesc {
/// Create a toolchain desc using input_host to fill in missing fields
pub(crate) fn resolve(self, input_host: &TargetTriple) -> Result<ToolchainDesc> {
let host = PartialTargetTriple::new(&input_host.0).ok_or_else(|| {
anyhow!(format!(
"Provided host '{}' couldn't be converted to partial triple",
input_host.0
))
})?;
let host_arch = host.arch.ok_or_else(|| {
anyhow!(format!(
"Provided host '{}' did not specify a CPU architecture",
input_host.0
))
})?;
let host_os = host.os.ok_or_else(|| {
anyhow!(format!(
"Provided host '{}' did not specify an operating system",
input_host.0
))
})?;
let host_env = host.env;
// If OS was specified, don't default to host environment, even if the OS matches
// the host OS, otherwise cannot specify no environment.
let env = if self.target.os.is_some() {
self.target.env
} else {
self.target.env.or(host_env)
};
let arch = self.target.arch.unwrap_or(host_arch);
let os = self.target.os.unwrap_or(host_os);
let trip = if let Some(env) = env {
format!("{arch}-{os}-{env}")
} else {
format!("{arch}-{os}")
};
Ok(ToolchainDesc {
channel: self.channel,
date: self.date,
target: TargetTriple(trip),
})
}
pub(crate) fn has_triple(&self) -> bool {
self.target.arch.is_some() || self.target.os.is_some() || self.target.env.is_some()
}
}
impl FromStr for ToolchainDesc {
type Err = anyhow::Error;
fn from_str(name: &str) -> Result<Self> {
let parsed: ParsedToolchainDesc = name.parse()?;
if parsed.target.is_none() {
return Err(anyhow!(RustupError::InvalidToolchainName(name.to_string())));
}
Ok(Self {
channel: parsed.channel,
date: parsed.date,
target: TargetTriple(parsed.target.unwrap()),
})
}
}
impl ToolchainDesc {
pub(crate) fn manifest_v1_url(&self, dist_root: &str) -> String {
let do_manifest_staging = process().var("RUSTUP_STAGED_MANIFEST").is_ok();
match (self.date.as_ref(), do_manifest_staging) {
(None, false) => format!("{}/channel-rust-{}", dist_root, self.channel),
(Some(date), false) => format!("{}/{}/channel-rust-{}", dist_root, date, self.channel),
(None, true) => format!("{}/staging/channel-rust-{}", dist_root, self.channel),
(Some(_), true) => panic!("not a real-world case"),
}
}
pub(crate) fn manifest_v2_url(&self, dist_root: &str) -> String {
format!("{}.toml", self.manifest_v1_url(dist_root))
}
/// Either "$channel" or "channel-$date"
pub fn manifest_name(&self) -> String {
match self.date {
None => self.channel.clone(),
Some(ref date) => format!("{}-{}", self.channel, date),
}
}
pub(crate) fn package_dir(&self, dist_root: &str) -> String {
match self.date {
None => dist_root.to_string(),
Some(ref date) => format!("{dist_root}/{date}"),
}
}
/// Toolchain channels are considered 'tracking' if it is one of the named channels
/// such as `stable`, or is an incomplete version such as `1.48`, and the
/// date field is empty.
pub(crate) fn is_tracking(&self) -> bool {
let channels = ["nightly", "beta", "stable"];
lazy_static! {
static ref TRACKING_VERSION: Regex = Regex::new(r"^\d{1}\.\d{1,3}$").unwrap();
}
(channels.iter().any(|x| *x == self.channel) || TRACKING_VERSION.is_match(&self.channel))
&& self.date.is_none()
}
}
impl TryFrom<&ToolchainName> for ToolchainDesc {
type Error = DistError;
fn try_from(value: &ToolchainName) -> std::result::Result<Self, Self::Error> {
match value {
ToolchainName::Custom(n) => Err(DistError::InvalidOfficialName(n.str().into())),
ToolchainName::Official(n) => Ok(n.clone()),
}
}
}
#[derive(Debug)]
pub(crate) struct Manifest<'a>(temp::File<'a>, String);
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)]
pub enum Profile {
Minimal,
Default,
Complete,
}
impl FromStr for Profile {
type Err = anyhow::Error;
fn from_str(name: &str) -> Result<Self> {
match name {
"minimal" | "m" => Ok(Self::Minimal),
"default" | "d" | "" => Ok(Self::Default),
"complete" | "c" => Ok(Self::Complete),
_ => Err(anyhow!(format!(
"unknown profile name: '{}'; valid profile names are: {}",
name,
valid_profile_names()
))),
}
}
}
impl Profile {
pub(crate) fn names() -> &'static [&'static str] {
&["minimal", "default", "complete"]
}
pub(crate) fn default_name() -> &'static str {
"default"
}
}
impl Default for Profile {
fn default() -> Self {
Self::Default
}
}
impl fmt::Display for TargetTriple {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
}
}
impl fmt::Display for PartialToolchainDesc {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", &self.channel)?;
if let Some(ref date) = self.date {
write!(f, "-{date}")?;
}
if let Some(ref arch) = self.target.arch {
write!(f, "-{arch}")?;
}
if let Some(ref os) = self.target.os {
write!(f, "-{os}")?;
}
if let Some(ref env) = self.target.env {
write!(f, "-{env}")?;
}
Ok(())
}
}
impl fmt::Display for ToolchainDesc {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", &self.channel)?;
if let Some(ref date) = self.date {
write!(f, "-{date}")?;
}
write!(f, "-{}", self.target)?;
Ok(())
}
}
impl fmt::Display for Profile {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Self::Minimal => write!(f, "minimal"),
Self::Default => write!(f, "default"),
Self::Complete => write!(f, "complete"),
}
}
}
pub(crate) fn valid_profile_names() -> String {
Profile::names()
.iter()
.map(|s| format!("'{s}'"))
.collect::<Vec<_>>()
.join(", ")
}
// Installs or updates a toolchain from a dist server. If an initial
// install then it will be installed with the default components. If
// an upgrade then all the existing components will be upgraded.
//
// Returns the manifest's hash if anything changed.
#[cfg_attr(feature = "otel", tracing::instrument(err, skip_all, fields(profile=format!("{profile:?}"), prefix=prefix.path().to_string_lossy().to_string())))]
pub(crate) fn update_from_dist(
download: DownloadCfg<'_>,
update_hash: Option<&Path>,
toolchain: &ToolchainDesc,
profile: Option<Profile>,
prefix: &InstallPrefix,
force_update: bool,
allow_downgrade: bool,
old_date: Option<&str>,
components: &[&str],
targets: &[&str],
) -> Result<Option<String>> {
let fresh_install = !prefix.path().exists();
let hash_exists = update_hash.map(Path::exists).unwrap_or(false);
// fresh_install means the toolchain isn't present, but hash_exists means there is a stray hash file
if fresh_install && hash_exists {
// It's ok to unwrap, because hash have to exist at this point
(download.notify_handler)(Notification::StrayHash(update_hash.unwrap()));
std::fs::remove_file(update_hash.unwrap())?;
}
let res = update_from_dist_(
download,
update_hash,
toolchain,
profile,
prefix,
force_update,
allow_downgrade,
old_date,
components,
targets,
);
// Don't leave behind an empty / broken installation directory
if res.is_err() && fresh_install {
// FIXME Ignoring cascading errors
let _ = utils::remove_dir("toolchain", prefix.path(), download.notify_handler);
}
res
}
fn update_from_dist_(
download: DownloadCfg<'_>,
update_hash: Option<&Path>,
toolchain: &ToolchainDesc,
profile: Option<Profile>,
prefix: &InstallPrefix,
force_update: bool,
allow_downgrade: bool,
old_date: Option<&str>,
components: &[&str],
targets: &[&str],
) -> Result<Option<String>> {
let mut toolchain = toolchain.clone();
let mut fetched = String::new();
let mut first_err = None;
let backtrack = toolchain.channel == "nightly" && toolchain.date.is_none();
// We want to limit backtracking if we do not already have a toolchain
let mut backtrack_limit: Option<i32> = if toolchain.date.is_some() {
None
} else {
// We limit the backtracking to 21 days by default (half a release cycle).
// The limit of 21 days is an arbitrary selection, so we let the user override it.
const BACKTRACK_LIMIT_DEFAULT: i32 = 21;
let provided = process()
.var("RUSTUP_BACKTRACK_LIMIT")
.ok()
.and_then(|v| v.parse().ok())
.unwrap_or(BACKTRACK_LIMIT_DEFAULT);
Some(if provided < 1 { 1 } else { provided })
};
// In case there is no allow-downgrade option set
// we never want to backtrack further back than the nightly that's already installed.
//
// If no nightly is installed, it makes no sense to backtrack beyond the first ever manifest,
// which is 2014-12-20 according to
// https://static.rust-lang.org/cargo-dist/index.html.
//
// We could arguably use the date of the first rustup release here, but that would break a
// bunch of the tests, which (inexplicably) use 2015-01-01 as their manifest dates.
let first_manifest = date_from_manifest_date("2014-12-20").unwrap();
let old_manifest = old_date
.and_then(date_from_manifest_date)
.unwrap_or(first_manifest);
let last_manifest = if allow_downgrade {
first_manifest
} else {
old_manifest
};
let current_manifest = {
let manifestation = Manifestation::open(prefix.clone(), toolchain.target.clone())?;
manifestation.load_manifest()?
};
loop {
match try_update_from_dist_(
download,
update_hash,
&toolchain,
profile,
prefix,
force_update,
components,
targets,
&mut fetched,
) {
Ok(v) => break Ok(v),
Err(e) => {
if !backtrack {
break Err(e);
}
let cause = e.downcast_ref::<DistError>();
match cause {
Some(DistError::ToolchainComponentsMissing(components, manifest, ..)) => {
(download.notify_handler)(Notification::SkippingNightlyMissingComponent(
&toolchain,
current_manifest.as_ref().unwrap_or(manifest),
components,
));
if first_err.is_none() {
first_err = Some(e);
}
// We decrement the backtrack count only on unavailable component errors
// so that the limit only applies to nightlies that were indeed available,
// and ignores missing ones.
backtrack_limit = backtrack_limit.map(|n| n - 1);
}
Some(DistError::MissingReleaseForToolchain(..)) => {
// no need to even print anything for missing nightlies,
// since we don't really "skip" them
}
_ => {
// All other errors break the loop
break Err(e);
}
};
if let Some(backtrack_limit) = backtrack_limit {
if backtrack_limit < 1 {
// This unwrap is safe because we can only hit this if we've
// had a chance to set first_err
break Err(first_err.unwrap());
}
}
// The user asked to update their nightly, but the latest nightly does not have all
// the components that the user currently has installed. Let's try the previous
// nightlies in reverse chronological order until we find a nightly that does,
// starting at one date earlier than the current manifest's date.
let toolchain_date = toolchain.date.as_ref().unwrap_or(&fetched);
let try_next = date_from_manifest_date(toolchain_date)
.unwrap_or_else(|| panic!("Malformed manifest date: {toolchain_date:?}"))
.pred_opt()
.unwrap();
if try_next < last_manifest {
// Wouldn't be an update if we go further back than the user's current nightly.
if let Some(e) = first_err {
break Err(e);
} else {
// In this case, all newer nightlies are missing, which means there are no
// updates, so the user is already at the latest nightly.
break Ok(None);
}
}
toolchain.date = Some(try_next.format("%Y-%m-%d").to_string());
}
}
}
}
fn try_update_from_dist_(
download: DownloadCfg<'_>,
update_hash: Option<&Path>,
toolchain: &ToolchainDesc,
profile: Option<Profile>,
prefix: &InstallPrefix,
force_update: bool,
components: &[&str],
targets: &[&str],
fetched: &mut String,
) -> Result<Option<String>> {
let toolchain_str = toolchain.to_string();
let manifestation = Manifestation::open(prefix.clone(), toolchain.target.clone())?;
// TODO: Add a notification about which manifest version is going to be used
(download.notify_handler)(Notification::DownloadingManifest(&toolchain_str));
match dl_v2_manifest(
download,
// Even if manifest has not changed, we must continue to install requested components.
// So if components or targets is not empty, we skip passing `update_hash` so that
// we essentially degenerate to `rustup component add` / `rustup target add`
if components.is_empty() && targets.is_empty() {
update_hash
} else {
None
},
toolchain,
) {
Ok(Some((m, hash))) => {
(download.notify_handler)(Notification::DownloadedManifest(
&m.date,
m.get_rust_version().ok(),
));
let profile_components = match profile {
Some(profile) => m.get_profile_components(profile, &toolchain.target)?,
None => Vec::new(),
};
let mut all_components: HashSet<Component> = profile_components.into_iter().collect();
let rust_package = m.get_package("rust")?;
let rust_target_package = rust_package.get_target(Some(&toolchain.target.clone()))?;
for component in components {
let mut component =
Component::new(component.to_string(), Some(toolchain.target.clone()), false);
if let Some(renamed) = m.rename_component(&component) {
component = renamed;
}
// Look up the newly constructed/renamed component and ensure that
// if it's a wildcard component we note such, otherwise we end up
// exacerbating the problem we thought we'd fixed with #2087 and #2115
if let Some(c) = rust_target_package
.components
.iter()
.find(|c| c.short_name_in_manifest() == component.short_name_in_manifest())
{
if c.target.is_none() {
component = component.wildcard();
}
}
all_components.insert(component);
}
for target in targets {
let triple = TargetTriple::new(target);
all_components.insert(Component::new("rust-std".to_string(), Some(triple), false));
}
let mut explicit_add_components: Vec<_> = all_components.into_iter().collect();
explicit_add_components.sort();
let changes = Changes {
explicit_add_components,
remove_components: Vec::new(),
};
*fetched = m.date.clone();
return match manifestation.update(
&m,
changes,
force_update,
&download,
&toolchain.manifest_name(),
true,
) {
Ok(status) => match status {
UpdateStatus::Unchanged => Ok(None),
UpdateStatus::Changed => Ok(Some(hash)),
},
Err(err) => match err.downcast_ref::<RustupError>() {
Some(RustupError::RequestedComponentsUnavailable {
components,
manifest,
toolchain,
}) => Err(anyhow!(DistError::ToolchainComponentsMissing(
components.to_owned(),
Box::new(manifest.to_owned()),
toolchain.to_owned(),
))),
Some(_) | None => Err(err),
},
};
}
Ok(None) => return Ok(None),
Err(any) => {
enum Cases {
DNE,
CF,
Other,
}
let case = match any.downcast_ref::<RustupError>() {
Some(RustupError::ChecksumFailed { .. }) => Cases::CF,
Some(RustupError::DownloadNotExists { .. }) => Cases::DNE,
_ => Cases::Other,
};
match case {
Cases::CF => return Ok(None),
Cases::DNE => {
// Proceed to try v1 as a fallback
(download.notify_handler)(Notification::DownloadingLegacyManifest);
}
Cases::Other => return Err(any),
}
}
}
// If the v2 manifest is not found then try v1
let manifest = match dl_v1_manifest(download, toolchain) {
Ok(m) => m,
Err(any) => {
enum Cases {
DNE,
CF,
Other,
}
let case = match any.downcast_ref::<RustupError>() {
Some(RustupError::ChecksumFailed { .. }) => Cases::CF,
Some(RustupError::DownloadNotExists { .. }) => Cases::DNE,
_ => Cases::Other,
};
match case {
Cases::DNE => {
bail!(DistError::MissingReleaseForToolchain(
toolchain.manifest_name()
));
}
Cases::CF => return Err(any),
Cases::Other => {
return Err(any).with_context(|| {
format!(
"failed to download manifest for '{}'",
toolchain.manifest_name()
)