forked from dotnet/msbuild
/
FrameworkLocationHelper.cs
1680 lines (1463 loc) · 79.3 KB
/
FrameworkLocationHelper.cs
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
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.Versioning;
using Microsoft.Win32;
using Microsoft.Build.Shared.FileSystem;
namespace Microsoft.Build.Shared
{
/// <summary>
/// Used to specify the targeted bitness of the .NET Framework for some methods of FrameworkLocationHelper
/// </summary>
internal enum DotNetFrameworkArchitecture
{
/// <summary>
/// Indicates the .NET Framework that is currently being run under.
/// </summary>
Current = 0,
/// <summary>
/// Indicates the 32-bit .NET Framework
/// </summary>
Bitness32 = 1,
/// <summary>
/// Indicates the 64-bit .NET Framework
/// </summary>
Bitness64 = 2
}
/// <summary>
/// FrameworkLocationHelper provides utility methods for locating .NET Framework and .NET Framework SDK directories and files
/// </summary>
internal static class FrameworkLocationHelper
{
#region Constants
internal const string dotNetFrameworkIdentifier = ".NETFramework";
// .net versions.
internal static readonly Version dotNetFrameworkVersion11 = new Version(1, 1);
internal static readonly Version dotNetFrameworkVersion20 = new Version(2, 0);
internal static readonly Version dotNetFrameworkVersion30 = new Version(3, 0);
internal static readonly Version dotNetFrameworkVersion35 = new Version(3, 5);
internal static readonly Version dotNetFrameworkVersion40 = new Version(4, 0);
internal static readonly Version dotNetFrameworkVersion45 = new Version(4, 5);
internal static readonly Version dotNetFrameworkVersion451 = new Version(4, 5, 1);
internal static readonly Version dotNetFrameworkVersion452 = new Version(4, 5, 2);
internal static readonly Version dotNetFrameworkVersion46 = new Version(4, 6);
internal static readonly Version dotNetFrameworkVersion461 = new Version(4, 6, 1);
internal static readonly Version dotNetFrameworkVersion462 = new Version(4, 6, 2);
internal static readonly Version dotNetFrameworkVersion47 = new Version(4, 7);
internal static readonly Version dotNetFrameworkVersion471 = new Version(4, 7, 1);
internal static readonly Version dotNetFrameworkVersion472 = new Version(4, 7, 2);
internal static readonly Version dotNetFrameworkVersion48 = new Version(4, 8);
// visual studio versions.
internal static readonly Version visualStudioVersion100 = new Version(10, 0);
internal static readonly Version visualStudioVersion110 = new Version(11, 0);
internal static readonly Version visualStudioVersion120 = new Version(12, 0);
internal static readonly Version visualStudioVersion140 = new Version(14, 0);
internal static readonly Version visualStudioVersion150 = new Version(15, 0);
// keep this up-to-date; always point to the latest visual studio version.
internal static readonly Version visualStudioVersionLatest = visualStudioVersion150;
private const string dotNetFrameworkRegistryPath = "SOFTWARE\\Microsoft\\.NETFramework";
private const string dotNetFrameworkSetupRegistryPath = "SOFTWARE\\Microsoft\\NET Framework Setup\\NDP";
private const string dotNetFrameworkSetupRegistryInstalledName = "Install";
internal const string fullDotNetFrameworkRegistryKey = "HKEY_LOCAL_MACHINE\\" + dotNetFrameworkRegistryPath;
#if FEATURE_WIN32_REGISTRY
private const string dotNetFrameworkAssemblyFoldersRegistryPath = dotNetFrameworkRegistryPath + "\\AssemblyFolders";
private const string referenceAssembliesRegistryValueName = "All Assemblies In";
#endif // FEATURE_WIN32_REGISTRY
internal const string dotNetFrameworkSdkInstallKeyValueV11 = "SDKInstallRootv1.1";
internal static string dotNetFrameworkVersionFolderPrefixV11 = NativeMethodsShared.IsWindows ? "v1.1" : "1.1"; // v1.1 is for Everett.
private const string dotNetFrameworkVersionV11 = "v1.1.4322"; // full Everett version to pass to NativeMethodsShared.GetRequestedRuntimeInfo().
private const string dotNetFrameworkRegistryKeyV11 = dotNetFrameworkSetupRegistryPath + "\\" + dotNetFrameworkVersionV11;
internal const string dotNetFrameworkSdkInstallKeyValueV20 = "SDKInstallRootv2.0";
internal static string dotNetFrameworkVersionFolderPrefixV20 = NativeMethodsShared.IsWindows ? "v2.0" : "2.0"; // v2.0 is for Whidbey.
private const string dotNetFrameworkVersionV20 = "v2.0.50727"; // full Whidbey version to pass to NativeMethodsShared.GetRequestedRuntimeInfo().
private const string dotNetFrameworkRegistryKeyV20 = dotNetFrameworkSetupRegistryPath + "\\" + dotNetFrameworkVersionV20;
internal static string dotNetFrameworkVersionFolderPrefixV30 = NativeMethodsShared.IsWindows ? "v3.0" : "3.0"; // v3.0 is for WinFx.
private static string s_dotNetFrameworkRegistryKeyV30 = dotNetFrameworkSetupRegistryPath + "\\" + dotNetFrameworkVersionFolderPrefixV30 + "\\Setup";
#if FEATURE_WIN32_REGISTRY
private const string fallbackDotNetFrameworkSdkRegistryInstallPath = "SOFTWARE\\Microsoft\\Microsoft SDKs\\Windows";
#endif // FEATURE_WIN32_REGISTRY
internal const string fallbackDotNetFrameworkSdkInstallKeyValue = "CurrentInstallFolder";
private const string dotNetFrameworkSdkRegistryPathForV35ToolsOnWinSDK70A = @"SOFTWARE\Microsoft\Microsoft SDKs\Windows\v7.0A\WinSDK-NetFx35Tools-x86";
private const string fullDotNetFrameworkSdkRegistryPathForV35ToolsOnWinSDK70A = "HKEY_LOCAL_MACHINE\\" + dotNetFrameworkSdkRegistryPathForV35ToolsOnWinSDK70A;
private const string dotNetFrameworkSdkRegistryPathForV35ToolsOnManagedToolsSDK80A = @"SOFTWARE\Microsoft\Microsoft SDKs\Windows\v8.0A\WinSDK-NetFx35Tools-x86";
private const string fullDotNetFrameworkSdkRegistryPathForV35ToolsOnManagedToolsSDK80A = "HKEY_LOCAL_MACHINE\\" + dotNetFrameworkSdkRegistryPathForV35ToolsOnManagedToolsSDK80A;
internal static string dotNetFrameworkVersionFolderPrefixV35 = NativeMethodsShared.IsWindows ? "v3.5" : "3.5"; // v3.5 is for Orcas.
private static string s_dotNetFrameworkRegistryKeyV35 = dotNetFrameworkSetupRegistryPath + "\\" + dotNetFrameworkVersionFolderPrefixV35;
internal const string fullDotNetFrameworkSdkRegistryKeyV35OnVS10 = fullDotNetFrameworkSdkRegistryPathForV35ToolsOnWinSDK70A;
internal const string fullDotNetFrameworkSdkRegistryKeyV35OnVS11 = fullDotNetFrameworkSdkRegistryPathForV35ToolsOnManagedToolsSDK80A;
internal static string dotNetFrameworkVersionFolderPrefixV40 = NativeMethodsShared.IsWindows ? "v4.0" : "4.0";
internal static string dotNetFrameworkVersionFolderPrefixV45 = NativeMethodsShared.IsWindows ? "v4.5" : "4.5";
#if FEATURE_WIN32_REGISTRY
/// <summary>
/// Path to the ToolsVersion definitions in the registry
/// </summary>
private const string ToolsVersionsRegistryPath = @"SOFTWARE\Microsoft\MSBuild\ToolsVersions";
#endif // FEATURE_WIN32_REGISTRY
#endregion // Constants
#region Static member variables
/// <summary>
/// By default when a root path is not specified we would like to use the program files directory \ reference assemblies\framework as the root location
/// to generate the reference assembly paths from.
/// </summary>
internal static readonly string programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
internal static readonly string programFiles32 = GenerateProgramFiles32();
internal static readonly string programFiles64 = GenerateProgramFiles64();
internal static readonly string programFilesReferenceAssemblyLocation = GenerateProgramFilesReferenceAssemblyRoot();
private static string s_fallbackDotNetFrameworkSdkInstallPath;
private static string s_pathToV35ToolsInFallbackDotNetFrameworkSdk;
private static string s_pathToV4ToolsInFallbackDotNetFrameworkSdk;
/// <summary>
/// List the supported .net versions.
/// </summary>
private static readonly DotNetFrameworkSpec[] s_dotNetFrameworkSpecs =
{
// v1.1
new DotNetFrameworkSpecLegacy(
dotNetFrameworkVersion11,
dotNetFrameworkRegistryKeyV11,
dotNetFrameworkSetupRegistryInstalledName,
dotNetFrameworkVersionFolderPrefixV11,
dotNetFrameworkSdkInstallKeyValueV11,
hasMSBuild: false),
// v2.0
new DotNetFrameworkSpecLegacy(
dotNetFrameworkVersion20,
dotNetFrameworkRegistryKeyV20,
dotNetFrameworkSetupRegistryInstalledName,
dotNetFrameworkVersionFolderPrefixV20,
dotNetFrameworkSdkInstallKeyValueV20,
hasMSBuild: true),
// v3.0
new DotNetFrameworkSpecV3(
dotNetFrameworkVersion30,
s_dotNetFrameworkRegistryKeyV30,
"InstallSuccess",
dotNetFrameworkVersionFolderPrefixV30,
null,
null,
hasMSBuild: false),
// v3.5
new DotNetFrameworkSpecV3(
dotNetFrameworkVersion35,
s_dotNetFrameworkRegistryKeyV35,
dotNetFrameworkSetupRegistryInstalledName,
dotNetFrameworkVersionFolderPrefixV35,
"WinSDK-NetFx35Tools-x86",
"InstallationFolder",
hasMSBuild: true),
// v4.0
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion40, visualStudioVersion100),
// v4.5
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion45, visualStudioVersion110),
// v4.5.1
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion451, visualStudioVersion120),
// v4.5.2
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion452, visualStudioVersion120),
// v4.6
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion46, visualStudioVersion140),
// v4.6.1
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion461, visualStudioVersion140),
// v4.6.2
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion462, visualStudioVersion150),
// v4.7
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion47, visualStudioVersion150),
// v4.7.1
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion471, visualStudioVersion150),
// v4.7.2
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion472, visualStudioVersion150),
// v4.8
CreateDotNetFrameworkSpecForV4(dotNetFrameworkVersion48, visualStudioVersion150),
};
/// <summary>
/// List the supported visual studio versions.
/// </summary>
/// <remarks>
/// The items must be ordered by the version, because some methods depend on that fact to find the previous visual studio version.
/// </remarks>
private static readonly VisualStudioSpec[] s_visualStudioSpecs =
{
// VS10
new VisualStudioSpec(visualStudioVersion100, "Windows\\v7.0A", null, null, new []
{
dotNetFrameworkVersion11,
dotNetFrameworkVersion20,
dotNetFrameworkVersion35,
dotNetFrameworkVersion40,
}),
// VS11
new VisualStudioSpec(visualStudioVersion110, "Windows\\v8.0A", "v8.0", "InstallationFolder", new []
{
dotNetFrameworkVersion11,
dotNetFrameworkVersion20,
dotNetFrameworkVersion35,
dotNetFrameworkVersion40,
dotNetFrameworkVersion45,
}),
// VS12
new VisualStudioSpec(visualStudioVersion120, "Windows\\v8.1A", "v8.1", "InstallationFolder", new []
{
dotNetFrameworkVersion11,
dotNetFrameworkVersion20,
dotNetFrameworkVersion35,
dotNetFrameworkVersion40,
dotNetFrameworkVersion45,
dotNetFrameworkVersion451,
dotNetFrameworkVersion452
}),
// VS14
new VisualStudioSpec(visualStudioVersion140, "NETFXSDK\\{0}", "v8.1", "InstallationFolder", new []
{
dotNetFrameworkVersion11,
dotNetFrameworkVersion20,
dotNetFrameworkVersion35,
dotNetFrameworkVersion40,
dotNetFrameworkVersion45,
dotNetFrameworkVersion451,
dotNetFrameworkVersion452,
dotNetFrameworkVersion46,
dotNetFrameworkVersion461
}),
// VS15
new VisualStudioSpec(visualStudioVersion150, "NETFXSDK\\{0}", "v8.1", "InstallationFolder", new []
{
dotNetFrameworkVersion11,
dotNetFrameworkVersion20,
dotNetFrameworkVersion35,
dotNetFrameworkVersion40,
dotNetFrameworkVersion45,
dotNetFrameworkVersion451,
dotNetFrameworkVersion452,
dotNetFrameworkVersion46,
dotNetFrameworkVersion461,
dotNetFrameworkVersion462,
dotNetFrameworkVersion47,
dotNetFrameworkVersion471,
dotNetFrameworkVersion472,
dotNetFrameworkVersion48,
}),
};
#if FEATURE_WIN32_REGISTRY
/// <summary>
/// Define explicit fallback rules for the request to get path of .net framework sdk tools folder.
/// The default rule is fallback to previous VS. However, there are some special cases that need
/// explicit rules, i.e. v4.5.1 on VS12 fallbacks to v4.5 on VS12.
/// </summary>
/// <remarks>
/// The rules are maintained in a 2-dimensions array. Each row defines a rule. The first column
/// defines the trigger condition. The second column defines the fallback .net and VS versions.
/// </remarks>
private static readonly (Version, Version)[,] s_explicitFallbackRulesForPathToDotNetFrameworkSdkTools =
{
// VS12
{ (dotNetFrameworkVersion451, visualStudioVersion120), (dotNetFrameworkVersion45, visualStudioVersion120) },
{ (dotNetFrameworkVersion452, visualStudioVersion120), (dotNetFrameworkVersion451, visualStudioVersion120) },
// VS14
{ (dotNetFrameworkVersion451, visualStudioVersion140), (dotNetFrameworkVersion45, visualStudioVersion140) },
{ (dotNetFrameworkVersion452, visualStudioVersion140), (dotNetFrameworkVersion451, visualStudioVersion140) },
{ (dotNetFrameworkVersion46, visualStudioVersion140), (dotNetFrameworkVersion451, visualStudioVersion140) },
{ (dotNetFrameworkVersion461, visualStudioVersion140), (dotNetFrameworkVersion46, visualStudioVersion140) },
// VS15
{ (dotNetFrameworkVersion451, visualStudioVersion150), (dotNetFrameworkVersion45, visualStudioVersion150) },
{ (dotNetFrameworkVersion452, visualStudioVersion150), (dotNetFrameworkVersion451, visualStudioVersion150) },
{ (dotNetFrameworkVersion46, visualStudioVersion150), (dotNetFrameworkVersion451, visualStudioVersion150) },
{ (dotNetFrameworkVersion461, visualStudioVersion150), (dotNetFrameworkVersion46, visualStudioVersion150) },
{ (dotNetFrameworkVersion462, visualStudioVersion150), (dotNetFrameworkVersion461, visualStudioVersion150) },
{ (dotNetFrameworkVersion47, visualStudioVersion150), (dotNetFrameworkVersion462, visualStudioVersion150) },
{ (dotNetFrameworkVersion471, visualStudioVersion150), (dotNetFrameworkVersion47, visualStudioVersion150) },
{ (dotNetFrameworkVersion472, visualStudioVersion150), (dotNetFrameworkVersion471, visualStudioVersion150) },
{ (dotNetFrameworkVersion48, visualStudioVersion150), (dotNetFrameworkVersion472, visualStudioVersion150) },
};
#endif // FEATURE_WIN32_REGISTRY
private static readonly IReadOnlyDictionary<Version, DotNetFrameworkSpec> s_dotNetFrameworkSpecDict;
private static readonly IReadOnlyDictionary<Version, VisualStudioSpec> s_visualStudioSpecDict;
#endregion // Static member variables
static FrameworkLocationHelper()
{
s_dotNetFrameworkSpecDict = s_dotNetFrameworkSpecs.ToDictionary(spec => spec.Version);
s_visualStudioSpecDict = s_visualStudioSpecs.ToDictionary(spec => spec.Version);
}
#region Static properties
internal static string PathToDotNetFrameworkV11
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV11)
: GetPathToDotNetFrameworkV11(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkV20
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV20)
: GetPathToDotNetFrameworkV20(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkV30
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV30)
: GetPathToDotNetFrameworkV30(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkV35
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV35)
: GetPathToDotNetFrameworkV35(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkV40
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV40)
: GetPathToDotNetFrameworkV40(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkV45
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV45)
: GetPathToDotNetFrameworkV45(DotNetFrameworkArchitecture.Current);
}
}
internal static string PathToDotNetFrameworkSdkV11
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV11)
: GetPathToDotNetFrameworkSdkTools(dotNetFrameworkVersion11, visualStudioVersionLatest);
}
}
internal static string PathToDotNetFrameworkSdkV20
{
get
{
return NativeMethodsShared.IsUnixLike
? Path.Combine(NativeMethodsShared.FrameworkBasePath, dotNetFrameworkVersionFolderPrefixV20)
: GetPathToDotNetFrameworkSdkTools(dotNetFrameworkVersion20, visualStudioVersionLatest);
}
}
/// <summary>
/// Because there is no longer a strong 1:1 mapping between FX versions and SDK
/// versions, if we're unable to locate the desired SDK version, we will try to
/// use whichever SDK version is installed by looking at the key pointing to the
/// "latest" version.
///
/// This isn't ideal, but it will allow our tasks to function on any of several
/// related SDKs even if they don't have exactly the same versions.
///
/// NOTE: This returns the path to the root of the fallback SDK
/// </summary>
private static string FallbackDotNetFrameworkSdkInstallPath
{
get
{
if (s_fallbackDotNetFrameworkSdkInstallPath == null)
{
// For non-Windows just get the current Framework path
if (!NativeMethodsShared.IsWindows)
{
s_fallbackDotNetFrameworkSdkInstallPath = NativeMethodsShared.FrameworkCurrentPath;
}
#if FEATURE_WIN32_REGISTRY
else
{
s_fallbackDotNetFrameworkSdkInstallPath =
FindRegistryValueUnderKey(
fallbackDotNetFrameworkSdkRegistryInstallPath,
fallbackDotNetFrameworkSdkInstallKeyValue);
if (EnvironmentUtilities.Is64BitProcess && s_fallbackDotNetFrameworkSdkInstallPath == null)
{
// Since we're 64-bit, what we just checked was the 64-bit fallback key -- so now let's
// check the 32-bit one too, just in case.
s_fallbackDotNetFrameworkSdkInstallPath =
FindRegistryValueUnderKey(
fallbackDotNetFrameworkSdkRegistryInstallPath,
fallbackDotNetFrameworkSdkInstallKeyValue,
RegistryView.Registry32);
}
}
#endif
}
return s_fallbackDotNetFrameworkSdkInstallPath;
}
}
/// <summary>
/// Because there is no longer a strong 1:1 mapping between FX versions and SDK
/// versions, if we're unable to locate the desired SDK version, we will try to
/// use whichever SDK version is installed by looking at the key pointing to the
/// "latest" version.
///
/// This isn't ideal, but it will allow our tasks to function on any of several
/// related SDKs even if they don't have exactly the same versions.
///
/// NOTE: This explicitly returns the path to the 3.5 tools (bin) under the fallback
/// SDK, to match the data we're pulling from the registry now.
/// </summary>
private static string PathToV35ToolsInFallbackDotNetFrameworkSdk
{
get
{
if (s_pathToV35ToolsInFallbackDotNetFrameworkSdk == null)
{
if (FallbackDotNetFrameworkSdkInstallPath != null)
{
if (NativeMethodsShared.IsWindows)
{
var endsWithASlash =
FallbackDotNetFrameworkSdkInstallPath.EndsWith(
Path.DirectorySeparatorChar.ToString(),
StringComparison.Ordinal);
s_pathToV35ToolsInFallbackDotNetFrameworkSdk =
Path.Combine(FallbackDotNetFrameworkSdkInstallPath, "bin");
// Path.Combine leaves no trailing slash, so if we had one before, be sure to add it back in
if (endsWithASlash)
{
s_pathToV35ToolsInFallbackDotNetFrameworkSdk += Path.DirectorySeparatorChar;
}
}
else
{
s_pathToV35ToolsInFallbackDotNetFrameworkSdk = FallbackDotNetFrameworkSdkInstallPath;
}
}
}
return s_pathToV35ToolsInFallbackDotNetFrameworkSdk;
}
}
/// <summary>
/// Because there is no longer a strong 1:1 mapping between FX versions and SDK
/// versions, if we're unable to locate the desired SDK version, we will try to
/// use whichever SDK version is installed by looking at the key pointing to the
/// "latest" version.
///
/// This isn't ideal, but it will allow our tasks to function on any of several
/// related SDKs even if they don't have exactly the same versions.
///
/// NOTE: This explicitly returns the path to the 4.X tools (bin\NetFX 4.0 Tools)
/// under the fallback SDK, to match the data we're pulling from the registry now.
/// </summary>
private static string PathToV4ToolsInFallbackDotNetFrameworkSdk
{
get
{
if (s_pathToV4ToolsInFallbackDotNetFrameworkSdk == null)
{
if (FallbackDotNetFrameworkSdkInstallPath != null)
{
if (NativeMethodsShared.IsWindows)
{
bool endsWithASlash = FallbackDotNetFrameworkSdkInstallPath.EndsWith(
"\\",
StringComparison.Ordinal);
s_pathToV4ToolsInFallbackDotNetFrameworkSdk = Path.Combine(FallbackDotNetFrameworkSdkInstallPath, "bin", "NetFX 4.0 Tools");
// Path.Combine leaves no trailing slash, so if we had one before, be sure to add it back in
if (endsWithASlash)
{
s_pathToV4ToolsInFallbackDotNetFrameworkSdk += "\\";
}
}
else
{
s_pathToV4ToolsInFallbackDotNetFrameworkSdk = FallbackDotNetFrameworkSdkInstallPath;
}
}
}
return s_pathToV4ToolsInFallbackDotNetFrameworkSdk;
}
}
#endregion // Static properties
#region Internal methods
internal static string GetDotNetFrameworkSdkRootRegistryKey(Version dotNetFrameworkVersion, Version visualStudioVersion)
{
RedirectVersionsIfNecessary(ref dotNetFrameworkVersion, ref visualStudioVersion);
var dotNetFrameworkSpec = GetDotNetFrameworkSpec(dotNetFrameworkVersion);
var visualStudioSpec = GetVisualStudioSpec(visualStudioVersion);
ErrorUtilities.VerifyThrowArgument(visualStudioSpec.SupportedDotNetFrameworkVersions.Contains(dotNetFrameworkVersion), "FrameworkLocationHelper.UnsupportedFrameworkVersion", dotNetFrameworkVersion);
return dotNetFrameworkSpec.GetDotNetFrameworkSdkRootRegistryKey(visualStudioSpec);
}
internal static string GetDotNetFrameworkSdkInstallKeyValue(Version dotNetFrameworkVersion, Version visualStudioVersion)
{
RedirectVersionsIfNecessary(ref dotNetFrameworkVersion, ref visualStudioVersion);
var dotNetFrameworkSpec = GetDotNetFrameworkSpec(dotNetFrameworkVersion);
var visualStudioSpec = GetVisualStudioSpec(visualStudioVersion);
ErrorUtilities.VerifyThrowArgument(visualStudioSpec.SupportedDotNetFrameworkVersions.Contains(dotNetFrameworkVersion), "FrameworkLocationHelper.UnsupportedFrameworkVersion", dotNetFrameworkVersion);
return dotNetFrameworkSpec.DotNetFrameworkSdkRegistryInstallationFolderName;
}
internal static string GetDotNetFrameworkVersionFolderPrefix(Version dotNetFrameworkVersion)
{
return GetDotNetFrameworkSpec(dotNetFrameworkVersion).DotNetFrameworkFolderPrefix;
}
internal static string GetPathToWindowsSdk(Version dotNetFrameworkVersion)
{
return GetDotNetFrameworkSpec(dotNetFrameworkVersion).GetPathToWindowsSdk();
}
internal static string GetPathToDotNetFrameworkReferenceAssemblies(Version dotNetFrameworkVersion)
{
return GetDotNetFrameworkSpec(dotNetFrameworkVersion).GetPathToDotNetFrameworkReferenceAssemblies();
}
internal static string GetPathToDotNetFrameworkSdkTools(Version dotNetFrameworkVersion, Version visualStudioVersion)
{
RedirectVersionsIfNecessary(ref dotNetFrameworkVersion, ref visualStudioVersion);
var dotNetFrameworkSpec = GetDotNetFrameworkSpec(dotNetFrameworkVersion);
var visualStudioSpec = GetVisualStudioSpec(visualStudioVersion);
ErrorUtilities.VerifyThrowArgument(visualStudioSpec.SupportedDotNetFrameworkVersions.Contains(dotNetFrameworkVersion), "FrameworkLocationHelper.UnsupportedFrameworkVersion", dotNetFrameworkVersion);
return dotNetFrameworkSpec.GetPathToDotNetFrameworkSdkTools(visualStudioSpec);
}
internal static string GetPathToDotNetFrameworkSdk(Version dotNetFrameworkVersion, Version visualStudioVersion)
{
RedirectVersionsIfNecessary(ref dotNetFrameworkVersion, ref visualStudioVersion);
var dotNetFrameworkSpec = GetDotNetFrameworkSpec(dotNetFrameworkVersion);
var visualStudioSpec = GetVisualStudioSpec(visualStudioVersion);
ErrorUtilities.VerifyThrowArgument(visualStudioSpec.SupportedDotNetFrameworkVersions.Contains(dotNetFrameworkVersion), "FrameworkLocationHelper.UnsupportedFrameworkVersion", dotNetFrameworkVersion);
return dotNetFrameworkSpec.GetPathToDotNetFrameworkSdk(visualStudioSpec);
}
internal static string GetPathToDotNetFrameworkV11(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion11, architecture);
}
internal static string GetPathToDotNetFrameworkV20(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion20, architecture);
}
internal static string GetPathToDotNetFrameworkV30(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion30, architecture);
}
internal static string GetPathToDotNetFrameworkV35(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion35, architecture);
}
internal static string GetPathToDotNetFrameworkV40(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion40, architecture);
}
internal static string GetPathToDotNetFrameworkV45(DotNetFrameworkArchitecture architecture)
{
return GetPathToDotNetFramework(dotNetFrameworkVersion45, architecture);
}
internal static string GetPathToDotNetFramework(Version version)
{
return GetPathToDotNetFramework(version, DotNetFrameworkArchitecture.Current);
}
internal static string GetPathToDotNetFramework(Version version, DotNetFrameworkArchitecture architecture)
{
return GetDotNetFrameworkSpec(version).GetPathToDotNetFramework(architecture);
}
#if FEATURE_INSTALLED_MSBUILD
/// <summary>
/// Check the registry key and value to see if the .net Framework is installed on the machine.
/// </summary>
/// <param name="registryEntryToCheckInstall">Registry path to look for the value</param>
/// <param name="registryValueToCheckInstall">Key to retrieve the value from</param>
/// <returns>True if the registry key is 1 false if it is not there. This method also return true if the complus enviornment variables are set.</returns>
private static bool CheckForFrameworkInstallation(string registryEntryToCheckInstall, string registryValueToCheckInstall)
{
// Get the complus install root and version
string complusInstallRoot = Environment.GetEnvironmentVariable("COMPLUS_INSTALLROOT");
string complusVersion = Environment.GetEnvironmentVariable("COMPLUS_VERSION");
// Complus is not set we need to make sure the framework we are targeting is installed. Check the registry key before trying to find the directory.
// If complus is set then we will return that directory as the framework directory, there is no need to check the registry value for the framework and it may not even be installed.
if (String.IsNullOrEmpty(complusInstallRoot) && String.IsNullOrEmpty(complusVersion))
{
if (NativeMethodsShared.IsWindows)
{
// If the registry entry is 1 then the framework is installed. Go ahead and find the directory. If it is not 1 then the framework is not installed, return null.
return String.Equals("1", FindRegistryValueUnderKey(registryEntryToCheckInstall, registryValueToCheckInstall), StringComparison.OrdinalIgnoreCase);
}
// False for non-windows since there is nothing in the registry
else
{
return false;
}
}
return true;
}
#endif
/// <summary>
/// Heuristic that first considers the current runtime path and then searches the base of that path for the given
/// frameworks version.
/// </summary>
/// <param name="currentRuntimePath">The path to the runtime that is currently executing.</param>
/// <param name="prefix">Should be something like 'v1.2' that indicates the runtime version we want.</param>
/// <param name="directoryExists">Function that checks if directory exists.</param>
/// <param name="getDirectories">Delegate to method that can return filesystem entries.</param>
/// <param name="architecture">.NET framework architecture</param>
/// <returns>Will return 'null' if there is no target frameworks on this machine.</returns>
internal static string FindDotNetFrameworkPath
(
string currentRuntimePath,
string prefix,
DirectoryExists directoryExists,
GetDirectories getDirectories,
DotNetFrameworkArchitecture architecture
)
{
if (!NativeMethodsShared.IsWindows)
{
if (!string.IsNullOrEmpty(prefix)
&& prefix.Substring(0, 1).Equals("v", StringComparison.OrdinalIgnoreCase))
{
prefix = prefix.Substring(1);
}
var frameworkPath = Path.Combine(NativeMethodsShared.FrameworkBasePath, prefix ?? string.Empty);
return directoryExists(frameworkPath) ? frameworkPath : null;
}
// If the COMPLUS variables are set, they override everything -- that's the directory we want.
string complusInstallRoot = Environment.GetEnvironmentVariable("COMPLUS_INSTALLROOT");
string complusVersion = Environment.GetEnvironmentVariable("COMPLUS_VERSION");
if (!String.IsNullOrEmpty(complusInstallRoot) && !String.IsNullOrEmpty(complusVersion))
{
return Path.Combine(complusInstallRoot, complusVersion);
}
// If the current runtime starts with correct prefix, then this is the runtime we want to use.
// However, only if we're requesting current architecture -- otherwise, the base path may be different, so we'll need to look it up.
string leaf = Path.GetFileName(currentRuntimePath);
if (leaf.StartsWith(prefix, StringComparison.Ordinal) && architecture == DotNetFrameworkArchitecture.Current)
{
return currentRuntimePath;
}
// We haven't managed to use exact methods to locate the FX, so
// search for the correct path with a heuristic.
string baseLocation = Path.GetDirectoryName(currentRuntimePath);
string searchPattern = prefix + "*";
int indexOfFramework64 = baseLocation.IndexOf("Framework64", StringComparison.OrdinalIgnoreCase);
if (indexOfFramework64 != -1 && architecture == DotNetFrameworkArchitecture.Bitness32)
{
// need to get rid of just the 64, but want to look up 'Framework64' rather than '64' to avoid the case where
// the path is something like 'C:\MyPath\64\Framework64'. 9 = length of 'Framework', to make the index match
// the location of the '64'.
int indexOf64 = indexOfFramework64 + 9;
string tempLocation = baseLocation;
baseLocation = tempLocation.Substring(0, indexOf64) + tempLocation.Substring(indexOf64 + 2, tempLocation.Length - indexOf64 - 2);
}
else if (indexOfFramework64 == -1 && architecture == DotNetFrameworkArchitecture.Bitness64)
{
// need to add 64 -- since this is a heuristic, we assume that we just need to append.
baseLocation += "64";
}
// we don't need to do anything if it's DotNetFrameworkArchitecture.Current.
string[] directories;
if (directoryExists(baseLocation))
{
directories = getDirectories(baseLocation, searchPattern);
}
else
{
// If we can't even find the base path, might as well give up now.
return null;
}
if (directories.Length == 0)
{
// Couldn't find the path, return a null.
return null;
}
// We don't care which one we choose, but we want to be predictible.
// The intention here is to choose the alphabetical maximum.
string max = directories[0];
// the max.EndsWith condition: pre beta 2 versions of v3.5 have build number like v3.5.20111.
// This was removed in beta2
// We should favor \v3.5 over \v3.5.xxxxx
// versions previous to 2.0 have .xxxx version numbers. 3.0 and 3.5 do not.
if (!max.EndsWith(prefix, StringComparison.OrdinalIgnoreCase))
{
for (int i = 1; i < directories.Length; ++i)
{
if (directories[i].EndsWith(prefix, StringComparison.OrdinalIgnoreCase))
{
max = directories[i];
break;
}
else if (String.Compare(directories[i], max, StringComparison.OrdinalIgnoreCase) > 0)
{
max = directories[i];
}
}
}
return max;
}
/// <summary>
/// Determine the 32 bit program files directory, this is used for finding where the reference assemblies live.
/// </summary>
internal static string GenerateProgramFiles32()
{
// With Mono, all we look for in Files32 should be found in the below location
if (!NativeMethodsShared.IsWindows && NativeMethodsShared.IsMono)
{
return Path.Combine(NativeMethodsShared.FrameworkBasePath, "xbuild");
}
// On a 64 bit machine we always want to use the program files x86. If we are running as a 64 bit process then this variable will be set correctly
// If we are on a 32 bit machine or running as a 32 bit process then this variable will be null and the programFiles variable will be correct.
string programFilesX86 = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86);
if (String.IsNullOrEmpty(programFilesX86))
{
// 32 bit box
programFilesX86 = programFiles;
}
return programFilesX86;
}
/// <summary>
/// Determine the 64-bit program files directory, used as the basis for MSBuildExtensionsPath64.
/// Returns null if we're not on a 64-bit machine
/// </summary>
internal static string GenerateProgramFiles64()
{
// With Mono, all we look for in Files32 should be found in the below location
if (!NativeMethodsShared.IsWindows && NativeMethodsShared.IsMono)
{
return Path.Combine(NativeMethodsShared.FrameworkBasePath, "xbuild");
}
string programFilesX64;
if (string.Equals(programFiles, programFiles32))
{
// either we're in a 32-bit window, or we're on a 32-bit machine.
// if we're on a 32-bit machine, ProgramW6432 won't exist
// if we're on a 64-bit machine, ProgramW6432 will point to the correct Program Files.
programFilesX64 = Environment.GetEnvironmentVariable("ProgramW6432");
}
else
{
// 64-bit window on a 64-bit machine; %ProgramFiles% points to the 64-bit
// Program Files already.
programFilesX64 = programFiles;
}
return programFilesX64;
}
/// <summary>
/// Generate the path to the program files reference assembly location by taking in the program files special folder and then
/// using that path to generate the path to the reference assemblies location.
/// </summary>
internal static string GenerateProgramFilesReferenceAssemblyRoot()
{
string combinedPath = Environment.GetEnvironmentVariable("ReferenceAssemblyRoot");
if (!String.IsNullOrEmpty(combinedPath))
{
combinedPath = Path.GetFullPath(combinedPath);
if (FileSystems.Default.DirectoryExists(combinedPath))
{
return combinedPath;
}
}
combinedPath = NativeMethodsShared.IsWindows
? Path.Combine(programFiles32, "Reference Assemblies\\Microsoft\\Framework")
: Path.Combine(NativeMethodsShared.FrameworkBasePath, "xbuild-frameworks");
return Path.GetFullPath(combinedPath);
}
/// <summary>
/// Given a ToolsVersion, find the path to the build tools folder for that ToolsVersion.
/// </summary>
/// <param name="toolsVersion">The ToolsVersion to look up</param>
/// <param name="architecture">Target build tools architecture.</param>
/// <returns>The path to the build tools folder for that ToolsVersion, if it exists, or
/// null otherwise</returns>
internal static string GeneratePathToBuildToolsForToolsVersion(string toolsVersion, DotNetFrameworkArchitecture architecture)
{
if (string.Equals(toolsVersion, MSBuildConstants.CurrentToolsVersion, StringComparison.Ordinal))
{
return GetPathToBuildToolsFromEnvironment(architecture);
}
string toolsPath = null;
#if FEATURE_WIN32_REGISTRY
// If we're not looking for the current tools version, try the registry.
toolsPath = GetPathToBuildToolsFromRegistry(toolsVersion, architecture);
#endif
// If all else fails, always use the current environment.
return toolsPath ?? GetPathToBuildToolsFromEnvironment(architecture);
}
/// <summary>
/// Take the parts of the Target framework moniker and formulate the reference assembly path based on the following pattern:
/// For a framework and version:
/// $(TargetFrameworkRootPath)\$(TargetFrameworkIdentifier)\$(TargetFrameworkVersion)
/// For a subtype:
/// $(TargetFrameworkRootPath)\$(TargetFrameworkIdentifier)\$(TargetFrameworkVersion)\SubType\$(TargetFrameworkSubType)
/// e.g.NET Framework v4.0 would locate its reference assemblies in:
/// \Program Files\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0
/// e.g.Silverlight v2.0 would locate its reference assemblies in:
/// \Program Files\Reference Assemblies\Microsoft\Framework\Silverlight\v2.0
/// e.g.NET Compact Framework v3.5, subtype PocketPC would locate its reference assemblies in:
/// \Program Files\Reference Assemblies\Microsoft\Framework\.NETCompactFramework\v3.5\SubType\PocketPC
/// </summary>
/// <returns>The path to the reference assembly location</returns>
internal static string GenerateReferenceAssemblyPath(string targetFrameworkRootPath, FrameworkName frameworkName)
{
ErrorUtilities.VerifyThrowArgumentNull(targetFrameworkRootPath, nameof(targetFrameworkRootPath));
ErrorUtilities.VerifyThrowArgumentNull(frameworkName, nameof(frameworkName));
try
{
string path = targetFrameworkRootPath;
path = Path.Combine(path, frameworkName.Identifier);
path = Path.Combine(path, "v" + frameworkName.Version.ToString());
if (!String.IsNullOrEmpty(frameworkName.Profile))
{
path = Path.Combine(path, "Profile");
path = Path.Combine(path, frameworkName.Profile);
}
return Path.GetFullPath(path);
}
catch (Exception e) when (ExceptionHandling.IsIoRelatedException(e))
{
ErrorUtilities.ThrowInvalidOperation("FrameworkLocationHelper.CouldNotGenerateReferenceAssemblyDirectory", targetFrameworkRootPath, frameworkName.ToString(), e.Message);
// The compiler does not see the massage above an as exception;
return null;
}
}
/// <summary>
/// Given a path, subtracts the requested number of directories and returns the result.
/// </summary>
/// <comments>
/// Internal only so that I can have the unit tests use it too, instead of duplicating the same code
/// </comments>
internal static string RemoveDirectories(string path, int numberOfLevelsToRemove)
{
ErrorUtilities.VerifyThrowArgumentOutOfRange(numberOfLevelsToRemove > 0, nameof(numberOfLevelsToRemove));
string fixedPath = null;
if (path != null)
{
// Record whether we had a slash or not so that we can tack it back on if necessary
var endedWithASlash = path.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal)
|| path.EndsWith(
Path.AltDirectorySeparatorChar.ToString(),
StringComparison.Ordinal);
DirectoryInfo fixedPathInfo = new DirectoryInfo(path);
for (int i = 0; i < numberOfLevelsToRemove; i++)
{
if (fixedPathInfo?.Parent != null)
{
fixedPathInfo = fixedPathInfo.Parent;
}
}
if (fixedPathInfo != null)
{
fixedPath = fixedPathInfo.FullName;
}
if (fixedPath != null && endedWithASlash)
{
fixedPath += Path.DirectorySeparatorChar;
}
}
return fixedPath;
}
/// <summary>
/// Look up the path to the build tools directory for the requested ToolsVersion in the .exe.config file of this executable
/// </summary>
private static string GetPathToBuildToolsFromEnvironment(DotNetFrameworkArchitecture architecture)
{
return architecture switch
{
DotNetFrameworkArchitecture.Bitness64 => BuildEnvironmentHelper.Instance.MSBuildToolsDirectory64,
DotNetFrameworkArchitecture.Bitness32 => BuildEnvironmentHelper.Instance.MSBuildToolsDirectory32,
_ => BuildEnvironmentHelper.Instance.CurrentMSBuildToolsDirectory,
};
}